Skip to content

Commit 22d2e18

Browse files
committed
add tests and api doc
1 parent cdc5792 commit 22d2e18

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

apiary.apib

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5027,7 +5027,6 @@ Loads tables from Storage into a Workspace. BigQuery supports only loading as vi
50275027
+ dataFileId (optional, number) - Required for loading file. File upload id. Can be used only to load file to file workspace.
50285028
+ destination (required) - Destination table name or folder for file workspace
50295029
+ rows (optional, number) - Limits the number of returned rows
5030-
+ days (optional, number) - `DEPRECATED will be removed in the future.` Return rows created or updated in the last X days.
50315030
+ seconds (optional, number) - Returns rows created or updated in the last X seconds.
50325031
+ changedSince (optional) - Currently only supported for Snowflake - Filtering by import date - timestamp of import is stored within each row. Both until and since values can be a unix timestamp.
50335032
**If the `days` or `seconds` parameter is set, this value is ignored.**
@@ -5077,7 +5076,13 @@ Loads tables from Storage into a Workspace. BigQuery supports only loading as vi
50775076
Default: false
50785077
+ overwrite (optional, boolean) - When preserve is true duplicate tables will be overwritten
50795078
Default: false
5080-
+ useView (optional, boolean) - (experimental) SNFLK (requires feature `input-mapping-read-only-storage`, aliases are not supported), BigQuery (working without feature, aliases are not supported) view will be created in workspace instead of loading table (only source and destination options are allowed)
5079+
+ 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).
5080+
+ Members
5081+
+ COPY
5082+
+ CLONE
5083+
+ VIEW
5084+
+ AUTO
5085+
+ dropTimestampColumn (optional, boolean) - (CLONE loadType only) When true _timestamp column is removed after table load
50815086
Default: false
50825087
+ preserve (optional, boolean) - Keep existing tables in the workspace, otherwise the workspace will be purged before loading
50835088
Default: false
@@ -5162,7 +5167,6 @@ Loads tables from Storage into a Workspace in [Development Branch](#reference/de
51625167
+ dataFileId (optional, number) - Required for loading file. File upload id. Can be used only to load file to file workspace.
51635168
+ destination (required) - Destination table name or folder for file workspace
51645169
+ rows (optional, number) - Limits the number of returned rows
5165-
+ days (optional, number) - `DEPRECATED will be removed in the future.` Return rows created or updated in the last X days.
51665170
+ seconds (optional, number) - Returns rows created or updated in the last X seconds.
51675171
+ changedSince (optional) - Currently only supported for Snowflake - Filtering by import date - timestamp of import is stored within each row. Both until and since values can be a unix timestamp.
51685172
**If the `days` or `seconds` parameter is set, this value is ignored.**
@@ -5212,7 +5216,13 @@ Loads tables from Storage into a Workspace in [Development Branch](#reference/de
52125216
Default: false
52135217
+ overwrite (optional, boolean) - When preserve is true duplicate tables will be overwritten
52145218
Default: false
5215-
+ useView (optional, boolean) - (experimental) SNFLK (requires feature `input-mapping-read-only-storage`, aliases don't work) view will be created in workspace instead of loading table (only source and destination options are allowed)
5219+
+ 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).
5220+
+ Members
5221+
+ COPY
5222+
+ CLONE
5223+
+ VIEW
5224+
+ AUTO
5225+
+ dropTimestampColumn (optional, boolean) - (CLONE loadType only) When true _timestamp column is removed after table load
52165226
Default: false
52175227
+ preserve (optional, boolean) - Keep existing tables in the workspace, otherwise the workspace will be purged before loading
52185228
Default: false
@@ -5281,9 +5291,13 @@ Loads tables from Storage into a Workspace in [Development Branch](#reference/de
52815291
}
52825292
52835293
5284-
## Load Data using CLONE [/v2/storage/workspaces/{workspace_id}/load-clone]
5294+
## DEPRECATED: Load Data using CLONE [/v2/storage/branch/{branch_id}/workspaces/{workspace_id}/load-clone]
5295+
5296+
**Deprecated use /load endpoint with loadType:CLONE**
5297+
5298+
### Load Data using CLONE [POST /v2/storage/branch/{branch_id}/workspaces/{workspace_id}/load-clone]
5299+
**Deprecated use /load endpoint with loadType:CLONE**
52855300
5286-
### Load Data using CLONE [POST]
52875301
Load tables from Storage into a Workspace using zero-copy cloning functionality in Snowflake. This load type does not
52885302
support any filtering or processing parameters. Only tables stored in Snowflake are supported.
52895303
@@ -5368,6 +5382,7 @@ when any of the row values were changed during an incremental import.
53685382
53695383
53705384
### Load Data using CLONE into Development Branch Workspace [POST /v2/storage/branch/{branch_id}/workspaces/{workspace_id}/load-clone]
5385+
**Deprecated use /load endpoint with loadType:CLONE**
53715386
53725387
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
53735388
support any filtering or processing parameters. Only tables stored in Snowflake are supported.

0 commit comments

Comments
 (0)