Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateDatabaseCatalog(ctx context.Context, req CreateDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
- func (c *Client) CreateDatabaseInstance(ctx context.Context, req CreateDatabaseInstanceRequest, opts ...call.Option) (*CreateDatabaseInstanceWaiter, error)
- func (c *Client) CreateDatabaseInstanceRole(ctx context.Context, req CreateDatabaseInstanceRoleRequest, ...) (*DatabaseInstanceRole, error)
- func (c *Client) CreateDatabaseTable(ctx context.Context, req CreateDatabaseTableRequest, opts ...call.Option) (*DatabaseTable, error)
- func (c *Client) CreateSyncedDatabaseTable(ctx context.Context, req CreateSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
- func (c *Client) DeleteDatabaseCatalog(ctx context.Context, req DeleteDatabaseCatalogRequest, opts ...call.Option) error
- func (c *Client) DeleteDatabaseInstance(ctx context.Context, req DeleteDatabaseInstanceRequest, opts ...call.Option) error
- func (c *Client) DeleteDatabaseInstanceRole(ctx context.Context, req DeleteDatabaseInstanceRoleRequest, ...) error
- func (c *Client) DeleteDatabaseTable(ctx context.Context, req DeleteDatabaseTableRequest, opts ...call.Option) error
- func (c *Client) DeleteSyncedDatabaseTable(ctx context.Context, req DeleteSyncedDatabaseTableRequest, opts ...call.Option) error
- func (c *Client) FindDatabaseInstanceByUid(ctx context.Context, req FindDatabaseInstanceByUidRequest, opts ...call.Option) (*DatabaseInstance, error)
- func (c *Client) GenerateDatabaseCredential(ctx context.Context, req GenerateDatabaseCredentialRequest, ...) (*DatabaseCredential, error)
- func (c *Client) GetDatabaseCatalog(ctx context.Context, req GetDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
- func (c *Client) GetDatabaseInstance(ctx context.Context, req GetDatabaseInstanceRequest, opts ...call.Option) (*DatabaseInstance, error)
- func (c *Client) GetDatabaseInstanceRole(ctx context.Context, req GetDatabaseInstanceRoleRequest, opts ...call.Option) (*DatabaseInstanceRole, error)
- func (c *Client) GetDatabaseTable(ctx context.Context, req GetDatabaseTableRequest, opts ...call.Option) (*DatabaseTable, error)
- func (c *Client) GetSyncedDatabaseTable(ctx context.Context, req GetSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
- func (c *Client) ListDatabaseCatalogs(ctx context.Context, req ListDatabaseCatalogsRequest, opts ...call.Option) (*ListDatabaseCatalogsResponse, error)
- func (c *Client) ListDatabaseCatalogsIter(ctx context.Context, req ListDatabaseCatalogsRequest, opts ...call.Option) iter.Seq2[*DatabaseCatalog, error]
- func (c *Client) ListDatabaseInstanceRoles(ctx context.Context, req ListDatabaseInstanceRolesRequest, opts ...call.Option) (*ListDatabaseInstanceRolesResponse, error)
- func (c *Client) ListDatabaseInstanceRolesIter(ctx context.Context, req ListDatabaseInstanceRolesRequest, opts ...call.Option) iter.Seq2[*DatabaseInstanceRole, error]
- func (c *Client) ListDatabaseInstances(ctx context.Context, req ListDatabaseInstancesRequest, opts ...call.Option) (*ListDatabaseInstancesResponse, error)
- func (c *Client) ListDatabaseInstancesIter(ctx context.Context, req ListDatabaseInstancesRequest, opts ...call.Option) iter.Seq2[*DatabaseInstance, error]
- func (c *Client) ListSyncedDatabaseTables(ctx context.Context, req ListSyncedDatabaseTablesRequest, opts ...call.Option) (*ListSyncedDatabaseTablesResponse, error)
- func (c *Client) ListSyncedDatabaseTablesIter(ctx context.Context, req ListSyncedDatabaseTablesRequest, opts ...call.Option) iter.Seq2[*SyncedDatabaseTable, error]
- func (c *Client) UpdateDatabaseCatalog(ctx context.Context, req UpdateDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
- func (c *Client) UpdateDatabaseInstance(ctx context.Context, req UpdateDatabaseInstanceRequest, opts ...call.Option) (*DatabaseInstance, error)
- func (c *Client) UpdateSyncedDatabaseTable(ctx context.Context, req UpdateSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
- type CreateDatabaseCatalogRequest
- type CreateDatabaseInstanceRequest
- type CreateDatabaseInstanceRoleRequest
- type CreateDatabaseInstanceWaiter
- type CreateDatabaseTableRequest
- type CreateSyncedDatabaseTableRequest
- type CustomTag
- type DatabaseCatalog
- type DatabaseCredential
- type DatabaseInstance
- type DatabaseInstanceRef
- type DatabaseInstanceRole
- type DatabaseInstanceRole_Attributes
- type DatabaseInstanceRole_IdentityType
- type DatabaseInstanceRole_MembershipRole
- type DatabaseInstance_State
- type DatabaseTable
- type DeleteDatabaseCatalogRequest
- type DeleteDatabaseInstanceRequest
- type DeleteDatabaseInstanceRoleRequest
- type DeleteDatabaseTableRequest
- type DeleteSyncedDatabaseTableRequest
- type DeltaTableSyncInfo
- type FindDatabaseInstanceByUidRequest
- type GenerateDatabaseCredentialRequest
- type GetDatabaseCatalogRequest
- type GetDatabaseInstanceRequest
- type GetDatabaseInstanceRoleRequest
- type GetDatabaseTableRequest
- type GetSyncedDatabaseTableRequest
- type ListDatabaseCatalogsRequest
- type ListDatabaseCatalogsResponse
- type ListDatabaseInstanceRolesRequest
- type ListDatabaseInstanceRolesResponse
- type ListDatabaseInstancesRequest
- type ListDatabaseInstancesResponse
- type ListSyncedDatabaseTablesRequest
- type ListSyncedDatabaseTablesResponse
- type NewPipelineSpec
- type ProvisioningInfo
- type ProvisioningInfo_State
- type ProvisioningPhase
- type RequestedClaims
- type RequestedClaims_PermissionSet
- type RequestedResource
- type RequestedResource_ResourceName_TableName
- type RequestedResource_ResourceName_UnspecifiedResourceName
- type SyncedDatabaseTable
- type SyncedTableContinuousUpdateStatus
- type SyncedTableFailedStatus
- type SyncedTablePipelineProgress
- type SyncedTablePosition
- type SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo
- type SyncedTableProvisioningStatus
- type SyncedTableSchedulingPolicy
- type SyncedTableSpec
- type SyncedTableSpec_PgSpecificType
- type SyncedTableSpec_TypeOverride
- type SyncedTableState
- type SyncedTableStatus
- type SyncedTableStatus_DetailedStatus_ContinuousUpdateStatus
- type SyncedTableStatus_DetailedStatus_FailedStatus
- type SyncedTableStatus_DetailedStatus_ProvisioningStatus
- type SyncedTableStatus_DetailedStatus_TriggeredUpdateStatus
- type SyncedTableTriggeredUpdateStatus
- type UpdateDatabaseCatalogRequest
- type UpdateDatabaseInstanceRequest
- type UpdateSyncedDatabaseTableRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) CreateDatabaseCatalog ¶
func (c *Client) CreateDatabaseCatalog(ctx context.Context, req CreateDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
Create a Database Catalog.
func (*Client) CreateDatabaseInstance ¶
func (c *Client) CreateDatabaseInstance(ctx context.Context, req CreateDatabaseInstanceRequest, opts ...call.Option) (*CreateDatabaseInstanceWaiter, error)
Create a Database Instance.
func (*Client) CreateDatabaseInstanceRole ¶
func (c *Client) CreateDatabaseInstanceRole(ctx context.Context, req CreateDatabaseInstanceRoleRequest, opts ...call.Option) (*DatabaseInstanceRole, error)
Create a role for a Database Instance.
func (*Client) CreateDatabaseTable ¶
func (c *Client) CreateDatabaseTable(ctx context.Context, req CreateDatabaseTableRequest, opts ...call.Option) (*DatabaseTable, error)
Create a Database Table. Useful for registering pre-existing PG tables in UC. See CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC.
func (*Client) CreateSyncedDatabaseTable ¶
func (c *Client) CreateSyncedDatabaseTable(ctx context.Context, req CreateSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
Create a Synced Database Table.
func (*Client) DeleteDatabaseCatalog ¶
func (c *Client) DeleteDatabaseCatalog(ctx context.Context, req DeleteDatabaseCatalogRequest, opts ...call.Option) error
Delete a Database Catalog.
func (*Client) DeleteDatabaseInstance ¶
func (c *Client) DeleteDatabaseInstance(ctx context.Context, req DeleteDatabaseInstanceRequest, opts ...call.Option) error
Delete a Database Instance.
func (*Client) DeleteDatabaseInstanceRole ¶
func (c *Client) DeleteDatabaseInstanceRole(ctx context.Context, req DeleteDatabaseInstanceRoleRequest, opts ...call.Option) error
Deletes a role for a Database Instance.
func (*Client) DeleteDatabaseTable ¶
func (c *Client) DeleteDatabaseTable(ctx context.Context, req DeleteDatabaseTableRequest, opts ...call.Option) error
Delete a Database Table.
func (*Client) DeleteSyncedDatabaseTable ¶
func (c *Client) DeleteSyncedDatabaseTable(ctx context.Context, req DeleteSyncedDatabaseTableRequest, opts ...call.Option) error
Delete a Synced Database Table.
func (*Client) FindDatabaseInstanceByUid ¶
func (c *Client) FindDatabaseInstanceByUid(ctx context.Context, req FindDatabaseInstanceByUidRequest, opts ...call.Option) (*DatabaseInstance, error)
Find a Database Instance by uid.
func (*Client) GenerateDatabaseCredential ¶
func (c *Client) GenerateDatabaseCredential(ctx context.Context, req GenerateDatabaseCredentialRequest, opts ...call.Option) (*DatabaseCredential, error)
Generates a credential that can be used to access database instances.
func (*Client) GetDatabaseCatalog ¶
func (c *Client) GetDatabaseCatalog(ctx context.Context, req GetDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
Get a Database Catalog.
func (*Client) GetDatabaseInstance ¶
func (c *Client) GetDatabaseInstance(ctx context.Context, req GetDatabaseInstanceRequest, opts ...call.Option) (*DatabaseInstance, error)
Get a Database Instance.
func (*Client) GetDatabaseInstanceRole ¶
func (c *Client) GetDatabaseInstanceRole(ctx context.Context, req GetDatabaseInstanceRoleRequest, opts ...call.Option) (*DatabaseInstanceRole, error)
Gets a role for a Database Instance.
func (*Client) GetDatabaseTable ¶
func (c *Client) GetDatabaseTable(ctx context.Context, req GetDatabaseTableRequest, opts ...call.Option) (*DatabaseTable, error)
Get a Database Table.
func (*Client) GetSyncedDatabaseTable ¶
func (c *Client) GetSyncedDatabaseTable(ctx context.Context, req GetSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
Get a Synced Database Table.
func (*Client) ListDatabaseCatalogs ¶
func (c *Client) ListDatabaseCatalogs(ctx context.Context, req ListDatabaseCatalogsRequest, opts ...call.Option) (*ListDatabaseCatalogsResponse, error)
This API is currently unimplemented, but exposed for Terraform support.
func (*Client) ListDatabaseCatalogsIter ¶
func (c *Client) ListDatabaseCatalogsIter(ctx context.Context, req ListDatabaseCatalogsRequest, opts ...call.Option) iter.Seq2[*DatabaseCatalog, error]
ListDatabaseCatalogsIter returns an iterator that iterates over the results of ListDatabaseCatalogs.
For example:
for item, err := range c.ListDatabaseCatalogsIter(ctx, ListDatabaseCatalogsRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListDatabaseCatalogs call made by the iterator under the hood.
Callers who need custom pagination logic should use ListDatabaseCatalogs directly.
func (*Client) ListDatabaseInstanceRoles ¶
func (c *Client) ListDatabaseInstanceRoles(ctx context.Context, req ListDatabaseInstanceRolesRequest, opts ...call.Option) (*ListDatabaseInstanceRolesResponse, error)
START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW. With more recent Lakebase V2 plans, we don't plan to ever advance these to PUBLIC_PREVIEW. These APIs will remain effectively undocumented/UI-only and we'll aim for a new public roles API as part of V2 PuPr.
func (*Client) ListDatabaseInstanceRolesIter ¶
func (c *Client) ListDatabaseInstanceRolesIter(ctx context.Context, req ListDatabaseInstanceRolesRequest, opts ...call.Option) iter.Seq2[*DatabaseInstanceRole, error]
ListDatabaseInstanceRolesIter returns an iterator that iterates over the results of ListDatabaseInstanceRoles.
For example:
for item, err := range c.ListDatabaseInstanceRolesIter(ctx, ListDatabaseInstanceRolesRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListDatabaseInstanceRoles call made by the iterator under the hood.
Callers who need custom pagination logic should use ListDatabaseInstanceRoles directly.
func (*Client) ListDatabaseInstances ¶
func (c *Client) ListDatabaseInstances(ctx context.Context, req ListDatabaseInstancesRequest, opts ...call.Option) (*ListDatabaseInstancesResponse, error)
List Database Instances.
func (*Client) ListDatabaseInstancesIter ¶
func (c *Client) ListDatabaseInstancesIter(ctx context.Context, req ListDatabaseInstancesRequest, opts ...call.Option) iter.Seq2[*DatabaseInstance, error]
ListDatabaseInstancesIter returns an iterator that iterates over the results of ListDatabaseInstances.
For example:
for item, err := range c.ListDatabaseInstancesIter(ctx, ListDatabaseInstancesRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListDatabaseInstances call made by the iterator under the hood.
Callers who need custom pagination logic should use ListDatabaseInstances directly.
func (*Client) ListSyncedDatabaseTables ¶
func (c *Client) ListSyncedDatabaseTables(ctx context.Context, req ListSyncedDatabaseTablesRequest, opts ...call.Option) (*ListSyncedDatabaseTablesResponse, error)
This API is currently unimplemented, but exposed for Terraform support.
func (*Client) ListSyncedDatabaseTablesIter ¶
func (c *Client) ListSyncedDatabaseTablesIter(ctx context.Context, req ListSyncedDatabaseTablesRequest, opts ...call.Option) iter.Seq2[*SyncedDatabaseTable, error]
ListSyncedDatabaseTablesIter returns an iterator that iterates over the results of ListSyncedDatabaseTables.
For example:
for item, err := range c.ListSyncedDatabaseTablesIter(ctx, ListSyncedDatabaseTablesRequest{}) {
if err != nil {
return err
}
fmt.Println(item)
}
Options opts are passed to each ListSyncedDatabaseTables call made by the iterator under the hood.
Callers who need custom pagination logic should use ListSyncedDatabaseTables directly.
func (*Client) UpdateDatabaseCatalog ¶
func (c *Client) UpdateDatabaseCatalog(ctx context.Context, req UpdateDatabaseCatalogRequest, opts ...call.Option) (*DatabaseCatalog, error)
This API is currently unimplemented, but exposed for Terraform support.
func (*Client) UpdateDatabaseInstance ¶
func (c *Client) UpdateDatabaseInstance(ctx context.Context, req UpdateDatabaseInstanceRequest, opts ...call.Option) (*DatabaseInstance, error)
Update a Database Instance.
func (*Client) UpdateSyncedDatabaseTable ¶
func (c *Client) UpdateSyncedDatabaseTable(ctx context.Context, req UpdateSyncedDatabaseTableRequest, opts ...call.Option) (*SyncedDatabaseTable, error)
This API is currently unimplemented, but exposed for Terraform support.
type CreateDatabaseCatalogRequest ¶
type CreateDatabaseCatalogRequest struct {
Catalog *DatabaseCatalog
}
type CreateDatabaseInstanceRequest ¶
type CreateDatabaseInstanceRequest struct {
// Instance to create.
DatabaseInstance *DatabaseInstance
}
type CreateDatabaseInstanceRoleRequest ¶
type CreateDatabaseInstanceRoleRequest struct {
InstanceName *string
DatabaseInstanceRole *DatabaseInstanceRole
DatabaseInstanceName *string
}
type CreateDatabaseInstanceWaiter ¶
type CreateDatabaseInstanceWaiter struct {
// contains filtered or unexported fields
}
CreateDatabaseInstanceWaiter tracks the state of the operation started by CreateDatabaseInstance.
func (*CreateDatabaseInstanceWaiter) Done ¶
Done polls once and reports whether the operation has reached a terminal state.
func (*CreateDatabaseInstanceWaiter) GetName ¶
func (w *CreateDatabaseInstanceWaiter) GetName() string
GetName returns the Name value used to identify the operation.
func (*CreateDatabaseInstanceWaiter) Wait ¶
func (w *CreateDatabaseInstanceWaiter) Wait(ctx context.Context, opts ...lro.Option) (*DatabaseInstance, error)
Wait polls until the operation reaches a terminal state.
type CreateDatabaseTableRequest ¶
type CreateDatabaseTableRequest struct {
Table *DatabaseTable
}
type CreateSyncedDatabaseTableRequest ¶
type CreateSyncedDatabaseTableRequest struct {
SyncedTable *SyncedDatabaseTable
}
type DatabaseCatalog ¶
type DatabaseCatalog struct {
// The name of the catalog in UC.
Name *string `fieldmask:"name"`
// The name of the DatabaseInstance housing the database.
DatabaseInstanceName *string `fieldmask:"database_instance_name"`
// The name of the database (in an instance) associated with the catalog.
DatabaseName *string `fieldmask:"database_name"`
Uid *string `fieldmask:"uid"`
CreateDatabaseIfNotExists *bool `fieldmask:"create_database_if_not_exists"`
}
type DatabaseCredential ¶
type DatabaseInstance ¶
type DatabaseInstance struct {
// An immutable UUID identifier for the instance.
Uid *string `fieldmask:"uid"`
// The name of the instance. This is the unique identifier for the instance.
Name *string `fieldmask:"name"`
// The email of the creator of the instance.
Creator *string `fieldmask:"creator"`
// The DNS endpoint to connect to the instance for read+write access.
ReadWriteDns *string `fieldmask:"read_write_dns"`
// The timestamp when the instance was created.
CreationTime *types.Time `fieldmask:"creation_time"`
// The current state of the instance.
State DatabaseInstance_State `fieldmask:"state"`
// The version of Postgres running on the instance.
PgVersion *string `fieldmask:"pg_version"`
// The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8".
Capacity *string `fieldmask:"capacity"`
// Deprecated. The sku of the instance; this field will always match the value
// of capacity. This is an output only field that contains the value computed
// from the input field combined with server side defaults. Use the field
// without the effective_ prefix to set the value.
EffectiveCapacity *string `fieldmask:"effective_capacity"`
// Whether to stop the instance. An input only param, see effective_stopped for
// the output.
Stopped *bool `fieldmask:"stopped"`
// Whether the instance is stopped. This is an output only field that contains
// the value computed from the input field combined with server side defaults.
// Use the field without the effective_ prefix to set the value.
EffectiveStopped *bool `fieldmask:"effective_stopped"`
// The number of nodes in the instance, composed of 1 primary and 0 or more
// secondaries. Defaults to 1 primary and 0 secondaries. This field is input
// only, see effective_node_count for the output.
NodeCount *int `fieldmask:"node_count"`
// The number of nodes in the instance, composed of 1 primary and 0 or more
// secondaries. Defaults to 1 primary and 0 secondaries. This is an output only
// field that contains the value computed from the input field combined with
// server side defaults. Use the field without the effective_ prefix to set the
// value.
EffectiveNodeCount *int `fieldmask:"effective_node_count"`
// Whether to enable secondaries to serve read-only traffic. Defaults to false.
EnableReadableSecondaries *bool `fieldmask:"enable_readable_secondaries"`
// Whether secondaries serving read-only traffic are enabled. Defaults to false.
// This is an output only field that contains the value computed from the input
// field combined with server side defaults. Use the field without the
// effective_ prefix to set the value.
EffectiveEnableReadableSecondaries *bool `fieldmask:"effective_enable_readable_secondaries"`
// The DNS endpoint to connect to the instance for read only access. This is
// only available if enable_readable_secondaries is true.
ReadOnlyDns *string `fieldmask:"read_only_dns"`
// The retention window for the instance. This is the time window in days for
// which the historical data is retained. The default value is 7 days. Valid
// values are 2 to 35 days.
RetentionWindowInDays *int `fieldmask:"retention_window_in_days"`
// The retention window for the instance. This is the time window in days for
// which the historical data is retained. This is an output only field that
// contains the value computed from the input field combined with server side
// defaults. Use the field without the effective_ prefix to set the value.
EffectiveRetentionWindowInDays *int `fieldmask:"effective_retention_window_in_days"`
// The ref of the parent instance. This is only available if the instance is
// child instance. Input: For specifying the parent instance to create a child
// instance. Optional. Output: Only populated if provided as input to create a
// child instance.
ParentInstanceRef *DatabaseInstanceRef `fieldmask:"parent_instance_ref"`
// The refs of the child instances. This is only available if the instance is
// parent instance.
ChildInstanceRefs []DatabaseInstanceRef `fieldmask:"child_instance_refs"`
// Whether to enable PG native password login on the instance. Defaults to
// false.
EnablePgNativeLogin *bool `fieldmask:"enable_pg_native_login"`
// Whether the instance has PG native password login enabled. This is an output
// only field that contains the value computed from the input field combined
// with server side defaults. Use the field without the effective_ prefix to set
// the value.
EffectiveEnablePgNativeLogin *bool `fieldmask:"effective_enable_pg_native_login"`
// The desired usage policy to associate with the instance.
UsagePolicyId *string `fieldmask:"usage_policy_id"`
// The policy that is applied to the instance. This is an output only field that
// contains the value computed from the input field combined with server side
// defaults. Use the field without the effective_ prefix to set the value.
EffectiveUsagePolicyId *string `fieldmask:"effective_usage_policy_id"`
// Custom tags associated with the instance. This field is only included on
// create and update responses.
CustomTags []CustomTag `fieldmask:"custom_tags"`
// The recorded custom tags associated with the instance. This is an output only
// field that contains the value computed from the input field combined with
// server side defaults. Use the field without the effective_ prefix to set the
// value.
EffectiveCustomTags []CustomTag `fieldmask:"effective_custom_tags"`
}
A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage..
type DatabaseInstanceRef ¶
type DatabaseInstanceRef struct {
// Id of the ref database instance.
Uid *string `fieldmask:"uid"`
// Name of the ref database instance.
Name *string `fieldmask:"name"`
// User-specified WAL LSN of the ref database instance.
//
// Input: For specifying the WAL LSN to create a child instance. Optional.
// Output: Only populated if provided as input to create a child instance.
Lsn *string `fieldmask:"lsn"`
// For a parent ref instance, this is the LSN on the parent instance from which
// the instance was created. For a child ref instance, this is the LSN on the
// instance from which the child instance was created. This is an output only
// field that contains the value computed from the input field combined with
// server side defaults. Use the field without the effective_ prefix to set the
// value.
EffectiveLsn *string `fieldmask:"effective_lsn"`
// Branch time of the ref database instance. For a parent ref instance, this is
// the point in time on the parent instance from which the instance was created.
// For a child ref instance, this is the point in time on the instance from
// which the child instance was created. Input: For specifying the point in time
// to create a child instance. Optional. Output: Only populated if provided as
// input to create a child instance.
BranchTime *types.Time `fieldmask:"branch_time"`
}
DatabaseInstanceRef is a reference to a database instance. It is used in the DatabaseInstance object to refer to the parent instance of an instance and to refer the child instances of an instance. To specify as a parent instance during creation of an instance, the lsn and branch_time fields are optional. If not specified, the child instance will be created from the latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to create the child instance..
type DatabaseInstanceRole ¶
type DatabaseInstanceRole struct {
// The name of the role. This is the unique identifier for the role in an
// instance.
Name *string
// The type of the role.
IdentityType DatabaseInstanceRole_IdentityType
// An enum value for a standard role that this role is a member of.
MembershipRole DatabaseInstanceRole_MembershipRole
// The desired API-exposed Postgres role attribute to associate with the role.
// Optional.
Attributes *DatabaseInstanceRole_Attributes
// The attributes that are applied to the role. This is an output only field
// that contains the value computed from the input field combined with server
// side defaults. Use the field without the effective_ prefix to set the value.
EffectiveAttributes *DatabaseInstanceRole_Attributes
InstanceName *string
}
A DatabaseInstanceRole represents a Postgres role in a database instance..
type DatabaseInstanceRole_Attributes ¶
Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical underscores between words. We were requested to make this a nested object/struct representation since these are knobs from an external spec..
type DatabaseInstanceRole_IdentityType ¶
type DatabaseInstanceRole_IdentityType string
const ( DatabaseInstanceRole_IdentityType_Unspecified DatabaseInstanceRole_IdentityType = "" // A role without a Databricks identity. DatabaseInstanceRole_IdentityType_PgOnly DatabaseInstanceRole_IdentityType = "PG_ONLY" // A user in a Databricks workspace. DatabaseInstanceRole_IdentityType_User DatabaseInstanceRole_IdentityType = "USER" // A service principal in a Databricks workspace. DatabaseInstanceRole_IdentityType_ServicePrincipal DatabaseInstanceRole_IdentityType = "SERVICE_PRINCIPAL" // A group in a Databricks workspace. DatabaseInstanceRole_IdentityType_Group DatabaseInstanceRole_IdentityType = "GROUP" )
type DatabaseInstanceRole_MembershipRole ¶
type DatabaseInstanceRole_MembershipRole string
Roles that the DatabaseInstanceRole can be a member of.
const ( DatabaseInstanceRole_MembershipRole_Unspecified DatabaseInstanceRole_MembershipRole = "" // Indicates membership in DATABRICKS_SUPERUSER, the highest set of privileges // exposed to customers. DatabaseInstanceRole_MembershipRole_DatabricksSuperuser DatabaseInstanceRole_MembershipRole = "DATABRICKS_SUPERUSER" )
type DatabaseInstance_State ¶
type DatabaseInstance_State string
const ( DatabaseInstance_State_Unspecified DatabaseInstance_State = "" // The instance is being brought online. DatabaseInstance_State_Starting DatabaseInstance_State = "STARTING" // The instance is active and ready to use. DatabaseInstance_State_Available DatabaseInstance_State = "AVAILABLE" // The instance is being deleted. DatabaseInstance_State_Deleting DatabaseInstance_State = "DELETING" // The instance is stopped. DatabaseInstance_State_Stopped DatabaseInstance_State = "STOPPED" // The instance is being updated. DatabaseInstance_State_Updating DatabaseInstance_State = "UPDATING" // The instance is failing over. DatabaseInstance_State_FailingOver DatabaseInstance_State = "FAILING_OVER" )
type DatabaseTable ¶
type DatabaseTable struct {
// Full three-part (catalog, schema, table) name of the table.
Name *string
// Name of the target database instance. This is required when creating database
// tables in standard catalogs. This is optional when creating database tables
// in registered catalogs. If this field is specified when creating database
// tables in registered catalogs, the database instance name MUST match that of
// the registered catalog (or the request will be rejected).
DatabaseInstanceName *string
// Target Postgres database object (logical database) name for this table.
//
// When creating a table in a standard catalog, this field is required. In this
// scenario, specifying this field will allow targeting an arbitrary postgres
// database.
//
// Registration of database tables via /database/tables is currently only
// supported in standard catalogs.
LogicalDatabaseName *string
}
type DeleteDatabaseCatalogRequest ¶
type DeleteDatabaseCatalogRequest struct {
Name *string
}
type DeleteDatabaseInstanceRequest ¶
type DeleteDatabaseInstanceRequest struct {
// Name of the instance to delete.
Name *string
// By default, an instance cannot be deleted if it has descendant instances
// created via PITR. If this flag is specified as true, all descendent instances
// will be deleted as well.
Force *bool
// Deprecated. Omitting the field or setting it to true will result in the field
// being hard deleted. Setting a value of false will throw a bad request.
Purge *bool
}
type DeleteDatabaseTableRequest ¶
type DeleteDatabaseTableRequest struct {
Name *string
}
type DeltaTableSyncInfo ¶
type DeltaTableSyncInfo struct {
// The Delta Lake commit version that was last successfully synced.
DeltaCommitVersion *int64 `fieldmask:"delta_commit_version"`
// The timestamp when the above Delta version was committed in the source Delta
// table. Note: This is the Delta commit time, not the time the data was written
// to the synced table.
DeltaCommitTimestamp *types.Time `fieldmask:"delta_commit_timestamp"`
}
type FindDatabaseInstanceByUidRequest ¶
type FindDatabaseInstanceByUidRequest struct {
// UID of the cluster to get.
Uid *string
}
type GenerateDatabaseCredentialRequest ¶
type GenerateDatabaseCredentialRequest struct {
RequestId *string
// Instances to request a credential for. At least one of instance_names or
// claims must be specified.
InstanceNames []string
// A set of UC permissions to add to the credential. We verify that the caller
// has the necessary permissions in UC and include a reference in the token.
// Postgres uses that token to give the connecting user additional grants to the
// Postgres resources that correspond to the UC resources. The UC resources need
// to be something that have a Postgres counterpart. For example, a synced table
// or a table in a UC database catalog.
Claims []RequestedClaims
}
Generates a credential that can be used to access database instances.
type GetDatabaseCatalogRequest ¶
type GetDatabaseCatalogRequest struct {
Name *string
}
type GetDatabaseInstanceRequest ¶
type GetDatabaseInstanceRequest struct {
// Name of the cluster to get.
Name *string
}
type GetDatabaseTableRequest ¶
type GetDatabaseTableRequest struct {
Name *string
}
type GetSyncedDatabaseTableRequest ¶
type GetSyncedDatabaseTableRequest struct {
Name *string
}
type ListDatabaseCatalogsResponse ¶
type ListDatabaseCatalogsResponse struct {
DatabaseCatalogs []DatabaseCatalog
// Pagination token to request the next page of database catalogs.
NextPageToken *string
}
type ListDatabaseInstanceRolesResponse ¶
type ListDatabaseInstanceRolesResponse struct {
// List of database instance roles.
DatabaseInstanceRoles []DatabaseInstanceRole
// Pagination token to request the next page of instances.
NextPageToken *string
}
type ListDatabaseInstancesResponse ¶
type ListDatabaseInstancesResponse struct {
// List of instances.
DatabaseInstances []DatabaseInstance
// Pagination token to request the next page of instances.
NextPageToken *string
}
type ListSyncedDatabaseTablesResponse ¶
type ListSyncedDatabaseTablesResponse struct {
SyncedTables []SyncedDatabaseTable
// Pagination token to request the next page of synced tables.
NextPageToken *string
}
type NewPipelineSpec ¶
type NewPipelineSpec struct {
// This field needs to be specified if the destination catalog is a managed
// postgres catalog.
//
// UC catalog for the pipeline to store intermediate files (checkpoints, event
// logs etc). This needs to be a standard catalog where the user has permissions
// to create Delta tables.
StorageCatalog *string `fieldmask:"storage_catalog"`
// This field needs to be specified if the destination catalog is a managed
// postgres catalog.
//
// UC schema for the pipeline to store intermediate files (checkpoints, event
// logs etc). This needs to be in the standard catalog where the user has
// permissions to create Delta tables.
StorageSchema *string `fieldmask:"storage_schema"`
// Budget policy to set on the newly created pipeline.
BudgetPolicyId *string `fieldmask:"budget_policy_id"`
}
Custom fields that user can set for pipeline while creating SyncedDatabaseTable. Note that other fields of pipeline are still inferred by table def internally.
type ProvisioningInfo ¶
type ProvisioningInfo struct {
}
Copied over from managed-catalog/api/messages/common.proto to decouple SDK packages. xref go/unified-api-packages-dd.
type ProvisioningInfo_State ¶
type ProvisioningInfo_State string
const ( ProvisioningInfo_State_Unspecified ProvisioningInfo_State = "" ProvisioningInfo_State_Provisioning ProvisioningInfo_State = "PROVISIONING" ProvisioningInfo_State_Active ProvisioningInfo_State = "ACTIVE" ProvisioningInfo_State_Failed ProvisioningInfo_State = "FAILED" ProvisioningInfo_State_Deleting ProvisioningInfo_State = "DELETING" ProvisioningInfo_State_Updating ProvisioningInfo_State = "UPDATING" ProvisioningInfo_State_Degraded ProvisioningInfo_State = "DEGRADED" )
type ProvisioningPhase ¶
type ProvisioningPhase string
const ( ProvisioningPhase_Unspecified ProvisioningPhase = "" // Ingestion phase of the synced table. This is when the synced table is // ingesting data from the delta table. ProvisioningPhase_ProvisioningPhaseMain ProvisioningPhase = "PROVISIONING_PHASE_MAIN" // Index scan phase of the synced table. This is when the synced table is // creating indexes on the ingested data. ProvisioningPhase_ProvisioningPhaseIndexScan ProvisioningPhase = "PROVISIONING_PHASE_INDEX_SCAN" // Index sort phase of the synced table. This is when the synced table is // creating indexes on the ingested data. ProvisioningPhase_ProvisioningPhaseIndexSort ProvisioningPhase = "PROVISIONING_PHASE_INDEX_SORT" )
type RequestedClaims ¶
type RequestedClaims struct {
PermissionSet RequestedClaims_PermissionSet
Resources []RequestedResource
}
type RequestedClaims_PermissionSet ¶
type RequestedClaims_PermissionSet string
Might add WRITE in the future
const ( RequestedClaims_PermissionSet_Unspecified RequestedClaims_PermissionSet = "" RequestedClaims_PermissionSet_ReadOnly RequestedClaims_PermissionSet = "READ_ONLY" )
type RequestedResource ¶
type RequestedResource struct {
// Might add UC_SCHEMA & UC_CATALOG later
ResourceName isRequestedResource_ResourceName
}
type RequestedResource_ResourceName_TableName ¶
type RequestedResource_ResourceName_TableName struct {
TableName string
}
RequestedResource_ResourceName_TableName selects TableName for RequestedResource.ResourceName.
type RequestedResource_ResourceName_UnspecifiedResourceName ¶
type RequestedResource_ResourceName_UnspecifiedResourceName struct {
UnspecifiedResourceName string
}
RequestedResource_ResourceName_UnspecifiedResourceName selects UnspecifiedResourceName for RequestedResource.ResourceName.
type SyncedDatabaseTable ¶
type SyncedDatabaseTable struct {
// Full three-part (catalog, schema, table) name of the table.
Name *string `fieldmask:"name"`
// Name of the target database instance. This is required when creating synced
// database tables in standard catalogs. This is optional when creating synced
// database tables in registered catalogs. If this field is specified when
// creating synced database tables in registered catalogs, the database instance
// name MUST match that of the registered catalog (or the request will be
// rejected).
DatabaseInstanceName *string `fieldmask:"database_instance_name"`
// The name of the database instance that this table is registered to. This
// field is always returned, and for tables inside database catalogs is inferred
// database instance associated with the catalog. This is an output only field
// that contains the value computed from the input field combined with server
// side defaults. Use the field without the effective_ prefix to set the value.
EffectiveDatabaseInstanceName *string `fieldmask:"effective_database_instance_name"`
// Target Postgres database object (logical database) name for this table.
//
// When creating a synced table in a registered Postgres catalog, the target
// Postgres database name is inferred to be that of the registered catalog. If
// this field is specified in this scenario, the Postgres database name MUST
// match that of the registered catalog (or the request will be rejected).
//
// When creating a synced table in a standard catalog, this field is required.
// In this scenario, specifying this field will allow targeting an arbitrary
// postgres database. Note that this has implications for the
// `create_database_objects_is_missing` field in `spec`.
LogicalDatabaseName *string `fieldmask:"logical_database_name"`
// The name of the logical database that this table is registered to. This is an
// output only field that contains the value computed from the input field
// combined with server side defaults. Use the field without the effective_
// prefix to set the value.
EffectiveLogicalDatabaseName *string `fieldmask:"effective_logical_database_name"`
Spec *SyncedTableSpec `fieldmask:"spec"`
// The provisioning state of the synced table entity in Unity Catalog. This is
// distinct from the state of the data synchronization pipeline (i.e. the table
// may be in "ACTIVE" but the pipeline may be in "PROVISIONING" as it runs
// asynchronously).
UnityCatalogProvisioningState ProvisioningInfo_State `fieldmask:"unity_catalog_provisioning_state"`
// Synced Table data synchronization status
DataSynchronizationStatus *SyncedTableStatus `fieldmask:"data_synchronization_status"`
}
type SyncedTableContinuousUpdateStatus ¶
type SyncedTableContinuousUpdateStatus struct {
// The last source table Delta version that was successfully synced to the
// synced table.
LastProcessedCommitVersion *int64 `fieldmask:"last_processed_commit_version"`
// The end timestamp of the last time any data was synchronized from the source
// table to the synced table. This is when the data is available in the synced
// table.
Timestamp *types.Time `fieldmask:"timestamp"`
// Progress of the initial data synchronization.
InitialPipelineSyncProgress *SyncedTablePipelineProgress `fieldmask:"initial_pipeline_sync_progress"`
}
Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE or the SYNCED_UPDATING_PIPELINE_RESOURCES state..
type SyncedTableFailedStatus ¶
type SyncedTableFailedStatus struct {
// The last source table Delta version that was successfully synced to the
// synced table. The last source table Delta version that was synced to the
// synced table. Only populated if the table is still synced and available for
// serving.
LastProcessedCommitVersion *int64 `fieldmask:"last_processed_commit_version"`
// The end timestamp of the last time any data was synchronized from the source
// table to the synced table. Only populated if the table is still synced and
// available for serving.
Timestamp *types.Time `fieldmask:"timestamp"`
}
Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the SYNCED_PIPELINE_FAILED state..
type SyncedTablePipelineProgress ¶
type SyncedTablePipelineProgress struct {
// The source table Delta version that was last processed by the pipeline. The
// pipeline may not have completely processed this version yet.
LatestVersionCurrentlyProcessing *int64 `fieldmask:"latest_version_currently_processing"`
// The number of rows that have been synced in this update.
SyncedRowCount *int64 `fieldmask:"synced_row_count"`
// The total number of rows that need to be synced in this update. This number
// may be an estimate.
TotalRowCount *int64 `fieldmask:"total_row_count"`
// The completion ratio of this update. This is a number between 0 and 1.
SyncProgressCompletion *float64 `fieldmask:"sync_progress_completion"`
// The estimated time remaining to complete this update in seconds.
EstimatedCompletionTimeSeconds *float64 `fieldmask:"estimated_completion_time_seconds"`
// The current phase of the data synchronization pipeline.
ProvisioningPhase ProvisioningPhase `fieldmask:"provisioning_phase"`
}
Progress information of the Synced Table data synchronization pipeline..
type SyncedTablePosition ¶
type SyncedTablePosition struct {
// The starting timestamp of the most recent successful synchronization from the
// source table to the destination (synced) table. Note this is the starting
// timestamp of the sync operation, not the end time. E.g., for a batch, this is
// the time when the sync operation started.
SyncStartTimestamp *types.Time `fieldmask:"sync_start_timestamp"`
// The end timestamp of the most recent successful synchronization. This is the
// time when the data is available in the synced table.
SyncEndTimestamp *types.Time `fieldmask:"sync_end_timestamp"`
// Information about the source system at the time of the last sync.
SourceSyncInfo isSyncedTablePosition_SourceSyncInfo
// contains filtered or unexported fields
}
type SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo ¶
type SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo struct {
DeltaTableSyncInfo DeltaTableSyncInfo `fieldmask:"delta_table_sync_info"`
}
SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo selects DeltaTableSyncInfo for SyncedTablePosition.SourceSyncInfo.
type SyncedTableProvisioningStatus ¶
type SyncedTableProvisioningStatus struct {
// Details about initial data synchronization. Only populated when in the
// PROVISIONING_INITIAL_SNAPSHOT state.
InitialPipelineSyncProgress *SyncedTablePipelineProgress `fieldmask:"initial_pipeline_sync_progress"`
}
Detailed status of a synced table. Shown if the synced table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state..
type SyncedTableSchedulingPolicy ¶
type SyncedTableSchedulingPolicy string
const ( SyncedTableSchedulingPolicy_Unspecified SyncedTableSchedulingPolicy = "" // Pipeline runs continuously after generating the initial data. Requires the // source table to have Change Data Feed (CDF) enabled. SyncedTableSchedulingPolicy_Continuous SyncedTableSchedulingPolicy = "CONTINUOUS" // Pipeline stops after generating the initial data and can be triggered later // (manually, through a cron job or through data triggers). Requires the source // table to have Change Data Feed (CDF) enabled. SyncedTableSchedulingPolicy_Triggered SyncedTableSchedulingPolicy = "TRIGGERED" // Pipeline stops after generating the initial data and can be triggered later // (manually, through a cron job or through data triggers). Successive updates // always perform a full copy of the source table data (no incremental updates). // Does not require the source table to have Change Data Feed (CDF) enabled. SyncedTableSchedulingPolicy_Snapshot SyncedTableSchedulingPolicy = "SNAPSHOT" )
type SyncedTableSpec ¶
type SyncedTableSpec struct {
// Scheduling policy of the underlying pipeline.
SchedulingPolicy SyncedTableSchedulingPolicy `fieldmask:"scheduling_policy"`
// Three-part (catalog, schema, table) name of the source Delta table.
SourceTableFullName *string `fieldmask:"source_table_full_name"`
// Primary Key columns to be used for data insert/update in the destination.
PrimaryKeyColumns []string `fieldmask:"primary_key_columns"`
// Time series key to deduplicate (tie-break) rows with the same primary key.
TimeseriesKey *string `fieldmask:"timeseries_key"`
// At most one of existing_pipeline_id and new_pipeline_spec should be defined.
//
// If existing_pipeline_id is defined, the synced table will be bin packed into
// the existing pipeline referenced. This avoids creating a new pipeline and
// allows sharing existing compute. In this case, the scheduling_policy of this
// synced table must match the scheduling policy of the existing pipeline.
ExistingPipelineId *string `fieldmask:"existing_pipeline_id"`
// If true, the synced table's logical database and schema resources in PG will
// be created if they do not already exist.
CreateDatabaseObjectsIfMissing *bool `fieldmask:"create_database_objects_if_missing"`
// At most one of existing_pipeline_id and new_pipeline_spec should be defined.
//
// If new_pipeline_spec is defined, a new pipeline is created for this synced
// table. The location pointed to is used to store intermediate files
// (checkpoints, event logs etc). The caller must have write permissions to
// create Delta tables in the specified catalog and schema. Again, note this
// requires write permissions, whereas the source table only requires read
// permissions.
NewPipelineSpec *NewPipelineSpec `fieldmask:"new_pipeline_spec"`
// When true, enables accelerated sync mode for the initial data load. This
// significantly improves performance for large tables. Requires workspace-level
// enablement.
AcceleratedSync *bool `fieldmask:"accelerated_sync"`
// Override the default Delta->PG type mapping for specific columns. A
// TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type
// must be set.
TypeOverrides []SyncedTableSpec_TypeOverride `fieldmask:"type_overrides"`
}
Specification of a synced database table..
type SyncedTableSpec_PgSpecificType ¶
type SyncedTableSpec_PgSpecificType string
PostgreSQL-specific target types that can override the default Delta-to-PG mapping.
const ( SyncedTableSpec_PgSpecificType_Unspecified SyncedTableSpec_PgSpecificType = "" // Maps the column to the pgvector vector type. SyncedTableSpec_PgSpecificType_PgSpecificTypeVector SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_VECTOR" // Maps the column to the pgvector half-precision halfvec type. SyncedTableSpec_PgSpecificType_PgSpecificTypeHalfvec SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_HALFVEC" // Maps the column to a length-bounded character varying(N) type. SyncedTableSpec_PgSpecificType_PgSpecificTypeVarchar SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_VARCHAR" )
type SyncedTableSpec_TypeOverride ¶
type SyncedTableSpec_TypeOverride struct {
// Name of the source column whose target PostgreSQL type should be overridden.
ColumnName *string
// PostgreSQL-specific target type to use for the column.
PgType SyncedTableSpec_PgSpecificType
// Size parameter for the target type, for types that take one (e.g. vector
// dimension, varchar length). Required when the chosen pg_type needs a size.
Size *int
}
Overrides the default Delta-to-PostgreSQL type mapping for a single column..
type SyncedTableState ¶
type SyncedTableState string
The state of a synced table.
const ( SyncedTableState_Unspecified SyncedTableState = "" // The synced table has just been created and resources are being provisioned. // This is also the catch-all state if there is not a more suitable state to // report for the synced table. SyncedTableState_SyncedTableProvisioning SyncedTableState = "SYNCED_TABLE_PROVISIONING" // The synced table is provisioning resources for the data synchronization // pipeline. SyncedTableState_SyncedTableProvisioningPipelineResources SyncedTableState = "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES" // The synced table is executing the initial data synchronization. SyncedTableState_SyncedTableProvisioningInitialSnapshot SyncedTableState = "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT" // The synced table is ready to serve data. SyncedTableState_SyncedTableOnline SyncedTableState = "SYNCED_TABLE_ONLINE" // The synced table is ready to serve data and is continuously updating. Only // shown for synced tables using the "Continuous" sync mode. SyncedTableState_SyncedTableOnlineContinuousUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE" // The synced table is ready to serve data and an active update is in progress. // Only shown for synced tables using the "Triggered" sync mode. SyncedTableState_SyncedTableOnlineTriggeredUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE" // The synced table is ready to serve data and there are no active updates. Only // shown for synced tables using the "Triggered" sync mode. SyncedTableState_SyncedTableOnlineNoPendingUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE" // The synced table has encountered an internal error and is not available for // serving. SyncedTableState_SyncedTabledOffline SyncedTableState = "SYNCED_TABLED_OFFLINE" // The synced table is not available for serving because the data // synchronization pipeline has failed. Please review the pipeline event logs to // troubleshoot. SyncedTableState_SyncedTableOfflineFailed SyncedTableState = "SYNCED_TABLE_OFFLINE_FAILED" // The data synchronization pipeline has encountered an error but the synced // table is still available for serving (potentially stale) data. Please review // the pipeline event logs to troubleshoot. SyncedTableState_SyncedTableOnlinePipelineFailed SyncedTableState = "SYNCED_TABLE_ONLINE_PIPELINE_FAILED" // The synced table is available for serving, and is provisioning resources for // a newly started data synchronization pipeline. SyncedTableState_SyncedTableOnlineUpdatingPipelineResources SyncedTableState = "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" )
type SyncedTableStatus ¶
type SyncedTableStatus struct {
// The state of the synced table.
DetailedState SyncedTableState `fieldmask:"detailed_state"`
// A text description of the current state of the synced table.
Message *string `fieldmask:"message"`
// The detailed status based on the synced table state.
DetailedStatus isSyncedTableStatus_DetailedStatus
// ID of the associated pipeline. The pipeline ID may have been provided by the
// client (in the case of bin packing), or generated by the server (when
// creating a new pipeline).
PipelineId *string `fieldmask:"pipeline_id"`
// Summary of the last successful synchronization from source to destination.
//
// Will always be present if there has been a successful sync. Even if the most
// recent syncs have failed.
//
// Limitation: The only exception is if the synced table is doing a FULL
// REFRESH, then the last sync information will not be available until the full
// refresh is complete. This limitation will be addressed in a future version.
//
// This top-level field is a convenience for consumers who want easy access to
// last sync information without having to traverse detailed_status.
LastSync *SyncedTablePosition `fieldmask:"last_sync"`
// contains filtered or unexported fields
}
Status of a synced table..
type SyncedTableStatus_DetailedStatus_ContinuousUpdateStatus ¶
type SyncedTableStatus_DetailedStatus_ContinuousUpdateStatus struct {
ContinuousUpdateStatus SyncedTableContinuousUpdateStatus `fieldmask:"continuous_update_status"`
}
SyncedTableStatus_DetailedStatus_ContinuousUpdateStatus selects ContinuousUpdateStatus for SyncedTableStatus.DetailedStatus.
type SyncedTableStatus_DetailedStatus_FailedStatus ¶
type SyncedTableStatus_DetailedStatus_FailedStatus struct {
FailedStatus SyncedTableFailedStatus `fieldmask:"failed_status"`
}
SyncedTableStatus_DetailedStatus_FailedStatus selects FailedStatus for SyncedTableStatus.DetailedStatus.
type SyncedTableStatus_DetailedStatus_ProvisioningStatus ¶
type SyncedTableStatus_DetailedStatus_ProvisioningStatus struct {
ProvisioningStatus SyncedTableProvisioningStatus `fieldmask:"provisioning_status"`
}
SyncedTableStatus_DetailedStatus_ProvisioningStatus selects ProvisioningStatus for SyncedTableStatus.DetailedStatus.
type SyncedTableStatus_DetailedStatus_TriggeredUpdateStatus ¶
type SyncedTableStatus_DetailedStatus_TriggeredUpdateStatus struct {
TriggeredUpdateStatus SyncedTableTriggeredUpdateStatus `fieldmask:"triggered_update_status"`
}
SyncedTableStatus_DetailedStatus_TriggeredUpdateStatus selects TriggeredUpdateStatus for SyncedTableStatus.DetailedStatus.
type SyncedTableTriggeredUpdateStatus ¶
type SyncedTableTriggeredUpdateStatus struct {
// The last source table Delta version that was successfully synced to the
// synced table.
LastProcessedCommitVersion *int64 `fieldmask:"last_processed_commit_version"`
// The end timestamp of the last time any data was synchronized from the source
// table to the synced table. This is when the data is available in the synced
// table.
Timestamp *types.Time `fieldmask:"timestamp"`
// Progress of the active data synchronization pipeline.
TriggeredUpdateProgress *SyncedTablePipelineProgress `fieldmask:"triggered_update_progress"`
}
Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE or the SYNCED_NO_PENDING_UPDATE state..
type UpdateDatabaseCatalogRequest ¶
type UpdateDatabaseCatalogRequest struct {
// Note that updating a database catalog is not yet supported.
DatabaseCatalog *DatabaseCatalog
// The list of fields to update. Setting this field is not yet supported.
UpdateMask *types.FieldMask[DatabaseCatalog]
}
type UpdateDatabaseInstanceRequest ¶
type UpdateDatabaseInstanceRequest struct {
DatabaseInstance *DatabaseInstance
// The list of fields to update. If unspecified, all fields will be updated when
// possible. To wipe out custom_tags, specify custom_tags in the update_mask
// with an empty custom_tags map.
UpdateMask *types.FieldMask[DatabaseInstance]
}
type UpdateSyncedDatabaseTableRequest ¶
type UpdateSyncedDatabaseTableRequest struct {
// Note that updating a synced database table is not yet supported.
SyncedTable *SyncedDatabaseTable
// The list of fields to update. Setting this field is not yet supported.
UpdateMask *types.FieldMask[SyncedDatabaseTable]
}