Resource: Schema
The application schema of a Firebase Data Connect service.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "annotations": { string: string, ... }, "datasources": [ { object ( |
Fields | |
---|---|
name |
Identifier. The relative resource name of the schema, in the format:
Right now, the only supported schema is "main". |
createTime |
Output only. [Output only] Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. [Output only] Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Optional. Labels as key value pairs. An object containing a list of |
annotations |
Optional. Stores small amounts of arbitrary data. An object containing a list of |
datasources[] |
Required. The data sources linked in the schema. |
source |
Required. The source files that comprise the application schema. |
uid |
Output only. System-assigned, unique identifier. |
reconciling |
Output only. A field that if true, indicates that the system is working to compile and deploy the schema. |
displayName |
Optional. Mutable human-readable name. 63 character limit. |
etag |
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 |
Datasource
A data source that backs Firebase Data Connect services.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field configuration . Settings and configurations of the underlying data source. configuration can be only one of the following: |
|
postgresql |
PostgreSQL configurations. |
PostgreSql
Settings for PostgreSQL data source.
JSON representation |
---|
{ "database": string, "schemaValidation": enum ( |
Fields | |
---|---|
database |
Required. Name of the PostgreSQL database. |
schemaValidation |
Optional. Configure how much Postgresql schema validation to perform. Default to |
Union field configuration . Settings and configurations of the underlying database. configuration can be only one of the following: |
|
cloudSql |
Cloud SQL configurations. |
CloudSqlInstance
Settings for CloudSQL instance configuration.
JSON representation |
---|
{ "instance": string } |
Fields | |
---|---|
instance |
Required. Name of the CloudSQL instance, in the format:
|
SqlSchemaValidation
Configure how much SQL Schema to perform for the given schema.
Enums | |
---|---|
SQL_SCHEMA_VALIDATION_UNSPECIFIED |
Unspecified SQL schema validation. Default to STRICT. |
NONE |
Skip no SQL schema validation. Use it with extreme caution. schemas.create or schemas.patch 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. |
Methods |
|
---|---|
|
Creates a new Schema in a given project and location. |
|
Deletes a single Schema. |
|
Gets details of a single Schema. |
|
Lists Schemas in a given project and location. |
|
Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema. |