gcp_firebasedataconnect_schema

ancestors

Type: UNORDERED_LIST_STRING

annotations

Type: MAP_STRING_STRING
Provider name: annotations
Description: Optional. Stores small amounts of arbitrary data.

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. [Output only] Create time stamp.

datasources

Type: UNORDERED_LIST_STRUCT
Provider name: datasources
Description: Required. The data sources linked in the schema.

• postgresql
  Type: STRUCT
  Provider name: postgresql
  Description: PostgreSQL configurations.
  
  • cloud_sql
    Type: STRUCT
    Provider name: cloudSql
    Description: Cloud SQL configurations.
    
    • instance
      Type: STRING
      Provider name: instance
      Description: Required. Name of the CloudSQL instance, in the format: projects/{project}/locations/{location}/instances/{instance}
      
  • database
    Type: STRING
    Provider name: database
    Description: Required. Name of the PostgreSQL database.
    
  • ephemeral
    Type: BOOLEAN
    Provider name: ephemeral
    Description: Output only. Ephemeral is true if this data connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the data connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, Data Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren’t transferred to the Cloud SQL instance. WARNING: When ephemeral=true, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions.
    
  • schema_migration
    Type: STRING
    Provider name: schemaMigration
    Description: Optional. Configure how to perform Postgresql schema migration.
    Possible values:
    
    • SQL_SCHEMA_MIGRATION_UNSPECIFIED - Unspecified SQL schema migration.
      
    • MIGRATE_COMPATIBLE - Connect to the SQL database and identify any missing SQL resources used in the given Firebase Data Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be schema_validation=STRICT.
      
  • schema_validation
    Type: STRING
    Provider name: schemaValidation
    Description: Optional. Configure how much Postgresql schema validation to perform.
    Possible values:
    
    • SQL_SCHEMA_VALIDATION_UNSPECIFIED - Unspecified SQL schema validation. Default to STRICT.
      
    • NONE - Skip no SQL schema validation. Use it with extreme caution. CreateSchema or UpdateSchema will succeed even if SQL database is unavailable or SQL schema is incompatible. Generated SQL may fail at execution time.
      
    • STRICT - Connect to the SQL database and validate that the SQL DDL matches the schema exactly. Surface any discrepancies as FAILED_PRECONDITION with an IncompatibleSqlSchemaError error detail.
      
    • COMPATIBLE - Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase Data Connect Schema. Surface any missing resources as FAILED_PRECONDITION with an IncompatibleSqlSchemaError error detail. Succeed even if there are unknown tables and columns.
      
  • unlinked
    Type: BOOLEAN
    Provider name: unlinked
    Description: No Postgres data source is linked. If set, don’t allow database and schema_validation to be configured.
    

etag

Type: STRING
Provider name: etag
Description: Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. AIP-154

gcp_display_name

Type: STRING
Provider name: displayName
Description: Optional. Mutable human-readable name. 63 character limit.

gcp_source

Type: STRUCT
Provider name: source
Description: Required. The source files that comprise the application schema.

• files
  Type: UNORDERED_LIST_STRUCT
  Provider name: files
  Description: Required. The files that comprise the source set.
  
  • content
    Type: STRING
    Provider name: content
    Description: Required. The file’s textual content.
    
  • path
    Type: STRING
    Provider name: path
    Description: Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/.gql).
    

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Identifier. The relative resource name of the schema, in the format: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Right now, the only supported schema is “main”.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. A field that if true, indicates that the system is working to compile and deploy the schema.

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING

uid

Type: STRING
Provider name: uid
Description: Output only. System-assigned, unique identifier.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. [Output only] Update time stamp.