Skip to content

Commit a4b8050

Browse files
committed
docs: update apiary API docs for BigQuery CLONE support
- Update loadType description: CLONE now supports Snowflake and BigQuery, rejects incremental loading, not supported for linked buckets on BigQuery - Update deprecated load-clone endpoints: supported on both backends, rejects incremental loading
1 parent 6d9a81a commit a4b8050

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

apiary.apib

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5118,7 +5118,7 @@ Loads tables from Storage into a Workspace. BigQuery supports only loading as vi
51185118
Default: false
51195119
+ overwrite (optional, boolean) - When preserve is true duplicate tables will be overwritten
51205120
Default: false
5121-
+ loadType (optional, enum[string]) - Select load type. Default: COPY. Use AUTO to let Storage API decide the best load type. Copy will be used always when filters or columns are set. Clone accepts only "source","destination" and "overwrite" options. View load type is experimental for SNFLK requires feature `input-mapping-read-only-storage`, aliases are not supported, for BigQuery working without feature, aliases are not supported. View will be created in workspace instead of loading table (View accepts only "source","destination" and "overwrite" options).
5121+
+ loadType (optional, enum[string]) - Select load type. Default: COPY. Use AUTO to let Storage API decide the best load type. Copy will be used always when filters, columns, or incremental are set. Clone is supported on Snowflake and BigQuery backends and accepts only "source", "destination", "overwrite" and "dropTimestampColumn" options. Clone is not supported with incremental loading or for linked buckets on BigQuery. View load type is experimental for SNFLK requires feature `input-mapping-read-only-storage`, aliases are not supported, for BigQuery working without feature, aliases are not supported. View will be created in workspace instead of loading table (View accepts only "source","destination" and "overwrite" options).
51225122
+ Members
51235123
+ COPY
51245124
+ CLONE
@@ -5246,7 +5246,7 @@ Loads tables from Storage into a Workspace in [Development Branch](#reference/de
52465246
Default: false
52475247
+ overwrite (optional, boolean) - When preserve is true duplicate tables will be overwritten
52485248
Default: false
5249-
+ loadType (optional, enum[string]) - Select load type. Default: COPY. Use AUTO to let Storage API decide the best load type. Copy will be used always when filters or columns are set. Clone accepts only "source","destination" and "overwrite" options. View load type is experimental for SNFLK requires feature `input-mapping-read-only-storage`, aliases are not supported, for BigQuery working without feature, aliases are not supported. View will be created in workspace instead of loading table (View accepts only "source","destination" and "overwrite" options).
5249+
+ loadType (optional, enum[string]) - Select load type. Default: COPY. Use AUTO to let Storage API decide the best load type. Copy will be used always when filters, columns, or incremental are set. Clone is supported on Snowflake and BigQuery backends and accepts only "source", "destination", "overwrite" and "dropTimestampColumn" options. Clone is not supported with incremental loading or for linked buckets on BigQuery. View load type is experimental for SNFLK requires feature `input-mapping-read-only-storage`, aliases are not supported, for BigQuery working without feature, aliases are not supported. View will be created in workspace instead of loading table (View accepts only "source","destination" and "overwrite" options).
52505250
+ Members
52515251
+ COPY
52525252
+ CLONE
@@ -5328,12 +5328,12 @@ Loads tables from Storage into a Workspace in [Development Branch](#reference/de
53285328
### Load Data using CLONE [POST /v2/storage/branch/{branch_id}/workspaces/{workspace_id}/load-clone]
53295329
**Deprecated use /load endpoint with loadType:CLONE**
53305330
5331-
Load tables from Storage into a Workspace using zero-copy cloning functionality in Snowflake. This load type does not
5332-
support any filtering or processing parameters. Only tables stored in Snowflake are supported.
5331+
Load tables from Storage into a Workspace using zero-copy cloning. Supported on Snowflake and BigQuery backends.
5332+
This load type does not support any filtering, processing parameters, or incremental loading.
5333+
Linked buckets are not supported on BigQuery.
53335334
5334-
The cloned table will contain all columns of the source table (all of them as `VARCHAR(1048576)`)
5335-
and a `_timestamp` system column.
5336-
This column contains a unix timestamp value (`TIMESTAMP_NTZ(9)`) when the row was added to the table or
5335+
The cloned table will contain all columns of the source table and a `_timestamp` system column.
5336+
This column contains a unix timestamp value when the row was added to the table or
53375337
when any of the row values were changed during an incremental import.
53385338
53395339
+ Parameters
@@ -5509,12 +5509,12 @@ from the workspace schema to file storage. The exported file can then be downloa
55095509
### Load Data using CLONE into Development Branch Workspace [POST /v2/storage/branch/{branch_id}/workspaces/{workspace_id}/load-clone]
55105510
**Deprecated use /load endpoint with loadType:CLONE**
55115511
5512-
Load tables from Storage into a Workspace in [Development Branch](#reference/development-branches) using zero-copy cloning functionality in Snowflake. This load type does not
5513-
support any filtering or processing parameters. Only tables stored in Snowflake are supported.
5512+
Load tables from Storage into a Workspace in [Development Branch](#reference/development-branches) using zero-copy cloning. Supported on Snowflake and BigQuery backends.
5513+
This load type does not support any filtering, processing parameters, or incremental loading.
5514+
Linked buckets are not supported on BigQuery.
55145515
5515-
The cloned table will contain all columns of the source table (all of them as `VARCHAR(1048576)`)
5516-
and a `_timestamp` system column.
5517-
This column contains a unix timestamp value (`TIMESTAMP_NTZ(9)`) when the row was added to the table or
5516+
The cloned table will contain all columns of the source table and a `_timestamp` system column.
5517+
This column contains a unix timestamp value when the row was added to the table or
55185518
when any of the row values were changed during an incremental import.
55195519
55205520
+ Parameters

0 commit comments

Comments
 (0)