Skip to main content
PATCH
/
v1
/
projects
/
{project}
/
sheets
/
{sheet}
{
  "name": "<string>",
  "title": "<string>",
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "content": "<string>",
  "contentSize": "<string>",
  "payload": {
    "type": "TYPE_UNSPECIFIED",
    "commands": [
      {
        "start": 123,
        "end": 123
      }
    ]
  },
  "engine": "ENGINE_UNSPECIFIED"
}

Path Parameters

​
project
string
required

The project id.

​
sheet
string
required

The sheet id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to be updated. Fields are specified relative to the sheet. (e.g., title, statement; not sheet.title or sheet.statement) Only support update the following fields for now:

  • title
  • statement
​
allowMissing
boolean

If set to true, and the sheet is not found, a new sheet will be created. In this situation, update_mask is ignored.

Body

application/json
​
name
string
required

The name of the sheet resource. Format: projects/{project}/sheets/{sheet} The sheet ID is generated by the server on creation and cannot be changed.

​
title
string
required

The title of the sheet.

​
content
string<bytes>
required

The content of the sheet. By default, it will be cut off, if it doesn't match the content_size, you can set the raw to true in GetSheet request to retrieve the full content.

​
engine
enum<string>
required

The SQL dialect.

Available options:
ENGINE_UNSPECIFIED,
CLICKHOUSE,
MYSQL,
POSTGRES,
SNOWFLAKE,
SQLITE,
TIDB,
MONGODB,
REDIS,
ORACLE,
SPANNER,
MSSQL,
REDSHIFT,
MARIADB,
OCEANBASE,
STARROCKS,
DORIS,
HIVE,
ELASTICSEARCH,
BIGQUERY,
DYNAMODB,
DATABRICKS,
COCKROACHDB,
COSMOSDB,
TRINO,
CASSANDRA
​
payload
object

Additional metadata and configuration for the sheet.

Response

OK

​
name
string
required

The name of the sheet resource. Format: projects/{project}/sheets/{sheet} The sheet ID is generated by the server on creation and cannot be changed.

​
title
string
required

The title of the sheet.

​
content
string<bytes>
required

The content of the sheet. By default, it will be cut off, if it doesn't match the content_size, you can set the raw to true in GetSheet request to retrieve the full content.

​
engine
enum<string>
required

The SQL dialect.

Available options:
ENGINE_UNSPECIFIED,
CLICKHOUSE,
MYSQL,
POSTGRES,
SNOWFLAKE,
SQLITE,
TIDB,
MONGODB,
REDIS,
ORACLE,
SPANNER,
MSSQL,
REDSHIFT,
MARIADB,
OCEANBASE,
STARROCKS,
DORIS,
HIVE,
ELASTICSEARCH,
BIGQUERY,
DYNAMODB,
DATABRICKS,
COCKROACHDB,
COSMOSDB,
TRINO,
CASSANDRA
​
creator
string

The creator of the Sheet. Format: users/{email}

​
createTime
string<date-time>

The create time of the sheet.

​
contentSize
string

content_size is the full size of the content, may not match the size of the content field.

​
payload
object

Additional metadata and configuration for the sheet.