v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the db v1alpha1 API group +kubebuilder:object:generate=true +groupName=db.atlasgo.io

Index

• Variables
• type AtlasSchema
  • func (in *AtlasSchema) DeepCopy() *AtlasSchema
  • func (in *AtlasSchema) DeepCopyInto(out *AtlasSchema)
  • func (in *AtlasSchema) DeepCopyObject() runtime.Object
• type AtlasSchemaList
  • func (in *AtlasSchemaList) DeepCopy() *AtlasSchemaList
  • func (in *AtlasSchemaList) DeepCopyInto(out *AtlasSchemaList)
  • func (in *AtlasSchemaList) DeepCopyObject() runtime.Object
• type AtlasSchemaSpec
  • func (in *AtlasSchemaSpec) DeepCopy() *AtlasSchemaSpec
  • func (in *AtlasSchemaSpec) DeepCopyInto(out *AtlasSchemaSpec)
• type AtlasSchemaStatus
  • func (in *AtlasSchemaStatus) DeepCopy() *AtlasSchemaStatus
  • func (in *AtlasSchemaStatus) DeepCopyInto(out *AtlasSchemaStatus)
• type CheckConfig
  • func (in *CheckConfig) DeepCopy() *CheckConfig
  • func (in *CheckConfig) DeepCopyInto(out *CheckConfig)
• type Diff
  • func (in *Diff) DeepCopy() *Diff
  • func (in *Diff) DeepCopyInto(out *Diff)
• type Lint
  • func (in *Lint) DeepCopy() *Lint
  • func (in *Lint) DeepCopyInto(out *Lint)
• type Policy
  • func (in *Policy) DeepCopy() *Policy
  • func (in *Policy) DeepCopyInto(out *Policy)
• type Schema
  • func (in *Schema) DeepCopy() *Schema
  • func (in *Schema) DeepCopyInto(out *Schema)
• type SkipChanges
  • func (in *SkipChanges) DeepCopy() *SkipChanges
  • func (in *SkipChanges) DeepCopyInto(out *SkipChanges)
• type URLFrom
  • func (in *URLFrom) DeepCopy() *URLFrom
  • func (in *URLFrom) DeepCopyInto(out *URLFrom)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "db.atlasgo.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type AtlasSchema

type AtlasSchema struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AtlasSchemaSpec   `json:"spec,omitempty"`
	Status AtlasSchemaStatus `json:"status,omitempty"`
}

AtlasSchema is the Schema for the atlasschemas API

func (*AtlasSchema) DeepCopy

func (in *AtlasSchema) DeepCopy() *AtlasSchema

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasSchema.

func (*AtlasSchema) DeepCopyInto

func (in *AtlasSchema) DeepCopyInto(out *AtlasSchema)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasSchema) DeepCopyObject

func (in *AtlasSchema) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasSchemaList

type AtlasSchemaList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasSchema `json:"items"`
}

AtlasSchemaList contains a list of AtlasSchema

func (*AtlasSchemaList) DeepCopy

func (in *AtlasSchemaList) DeepCopy() *AtlasSchemaList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasSchemaList.

func (*AtlasSchemaList) DeepCopyInto

func (in *AtlasSchemaList) DeepCopyInto(out *AtlasSchemaList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasSchemaList) DeepCopyObject

func (in *AtlasSchemaList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasSchemaSpec

type AtlasSchemaSpec struct {
	// URL of the target database schema.
	URL string `json:"url,omitempty"`
	// URLs may be defined as a secret key reference.
	URLFrom URLFrom `json:"urlFrom,omitempty"`
	// Desired Schema of the target.
	Schema Schema `json:"schema,omitempty"`
	// Exclude a list of glob patterns used to filter existing resources being taken into account.
	Exclude []string `json:"exclude,omitempty"`
	// Policy defines the policies to apply when managing the schema change lifecycle.
	Policy Policy `json:"policy,omitempty"`
	// The names of the schemas (named databases) on the target database to be managed.
	Schemas []string `json:"schemas,omitempty"`
}

AtlasSchemaSpec defines the desired state of AtlasSchema

func (*AtlasSchemaSpec) DeepCopy

func (in *AtlasSchemaSpec) DeepCopy() *AtlasSchemaSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasSchemaSpec.

func (*AtlasSchemaSpec) DeepCopyInto

func (in *AtlasSchemaSpec) DeepCopyInto(out *AtlasSchemaSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasSchemaStatus

type AtlasSchemaStatus struct {
	// Conditions represent the latest available observations of an object's state.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// ObservedHash is the hash of the most recently applied schema.
	ObservedHash string `json:"observed_hash"`
	// LastApplied is the unix timestamp of the most recent successful schema apply operation.
	LastApplied int64 `json:"last_applied"`
}

AtlasSchemaStatus defines the observed state of AtlasSchema

func (*AtlasSchemaStatus) DeepCopy

func (in *AtlasSchemaStatus) DeepCopy() *AtlasSchemaStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasSchemaStatus.

func (*AtlasSchemaStatus) DeepCopyInto

func (in *AtlasSchemaStatus) DeepCopyInto(out *AtlasSchemaStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CheckConfig

type CheckConfig struct {
	Error bool `json:"error,omitempty"`
}

CheckConfig defines the configuration of a linting check.

func (*CheckConfig) DeepCopy

func (in *CheckConfig) DeepCopy() *CheckConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CheckConfig.

func (*CheckConfig) DeepCopyInto

func (in *CheckConfig) DeepCopyInto(out *CheckConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Diff

type Diff struct {
	Skip SkipChanges `json:"skip,omitempty"`
}

Diff defines the diff policies to apply when planning schema changes.

func (*Diff) DeepCopy

func (in *Diff) DeepCopy() *Diff

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Diff.

func (*Diff) DeepCopyInto

func (in *Diff) DeepCopyInto(out *Diff)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Lint

type Lint struct {
	Destructive CheckConfig `json:"destructive,omitempty"`
}

Lint defines the linting policies to apply before applying the schema.

func (*Lint) DeepCopy

func (in *Lint) DeepCopy() *Lint

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Lint.

func (*Lint) DeepCopyInto

func (in *Lint) DeepCopyInto(out *Lint)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Policy

type Policy struct {
	Lint Lint `json:"lint,omitempty"`
	Diff Diff `json:"diff,omitempty"`
}

Policy defines the policies to apply when managing the schema change lifecycle.

func (*Policy) DeepCopy

func (in *Policy) DeepCopy() *Policy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.

func (*Policy) DeepCopyInto

func (in *Policy) DeepCopyInto(out *Policy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Schema

type Schema struct {
	SQL             string                       `json:"sql,omitempty"`
	HCL             string                       `json:"hcl,omitempty"`
	ConfigMapKeyRef *corev1.ConfigMapKeySelector `json:"configMapKeyRef,omitempty"`
}

Schema defines the desired state of the target database schema in plain SQL or HCL.

func (*Schema) DeepCopy

func (in *Schema) DeepCopy() *Schema

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Schema.

func (*Schema) DeepCopyInto

func (in *Schema) DeepCopyInto(out *Schema)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SkipChanges

type SkipChanges struct {
	// +optional
	AddSchema bool `json:"add_schema,omitempty"`
	// +optional
	DropSchema bool `json:"drop_schema,omitempty"`
	// +optional
	ModifySchema bool `json:"modify_schema,omitempty"`
	// +optional
	AddTable bool `json:"add_table,omitempty"`
	// +optional
	DropTable bool `json:"drop_table,omitempty"`
	// +optional
	ModifyTable bool `json:"modify_table,omitempty"`
	// +optional
	AddColumn bool `json:"add_column,omitempty"`
	// +optional
	DropColumn bool `json:"drop_column,omitempty"`
	// +optional
	ModifyColumn bool `json:"modify_column,omitempty"`
	// +optional
	AddIndex bool `json:"add_index,omitempty"`
	// +optional
	DropIndex bool `json:"drop_index,omitempty"`
	// +optional
	ModifyIndex bool `json:"modify_index,omitempty"`
	// +optional
	AddForeignKey bool `json:"add_foreign_key,omitempty"`
	// +optional
	DropForeignKey bool `json:"drop_foreign_key,omitempty"`
	// +optional
	ModifyForeignKey bool `json:"modify_foreign_key,omitempty"`
}

SkipChanges represents the skip changes policy.

func (*SkipChanges) DeepCopy

func (in *SkipChanges) DeepCopy() *SkipChanges

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SkipChanges.

func (*SkipChanges) DeepCopyInto

func (in *SkipChanges) DeepCopyInto(out *SkipChanges)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type URLFrom

type URLFrom struct {
	// SecretKeyRef references to the key of a secret in the same namespace.
	SecretKeyRef *corev1.SecretKeySelector `json:"secretKeyRef,omitempty"`
}

URLFrom defines a reference to a secret key that contains the Atlas URL of the target database schema.

func (*URLFrom) DeepCopy

func (in *URLFrom) DeepCopy() *URLFrom

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new URLFrom.

func (*URLFrom) DeepCopyInto

func (in *URLFrom) DeepCopyInto(out *URLFrom)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.