Iceberg Table

List iceberg tables

GET/api/v2/databases/{database}/schemas/{schema}/iceberg-tables
Lists the Apache Iceberg™ tables for which you have access privileges.

Path Parameters

ParameterDescription
database 
Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases.
schema 
Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database.

Query Parameters

ParameterDescription
like string
Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWith string
Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimit integer
Parameter to limit the maximum number of rows returned by a command.
fromName string
Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.
deep boolean
Optionally includes dependency information of the table.

Response

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create a snowflake managed iceberg table (clone and undrop are separate subresources)

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables
Create a snowflake managed iceberg table (clone and undrop are separate subresources)

Query Parameters

ParameterDescription
createMode string
Parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
copyGrants boolean
Parameter to enable copy grants when creating the object.

Response

CodeDescription
200
Successful request.
202

Create a snowflake managed iceberg table as select

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables:as-select
Create a snowflake managed iceberg table as select

Query Parameters

ParameterDescription
query string
The SQL select query to run to set up the table values (and possibly columns).

Response

CodeDescription
200
202

Create an unmanaged iceberg table from AWS Glue catalog

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables:from-aws-glue-catalog
Create an unmanaged iceberg table from AWS Glue catalog

Response

CodeDescription
200
202

Create an unmanaged iceberg table from Delta

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables:from-delta
Create an unmanaged iceberg table from Delta

Response

CodeDescription
200
202

Create an unmanaged iceberg table from Iceberg files

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables:from-iceberg-files
Create an unmanaged iceberg table from Iceberg files

Response

CodeDescription
200
202

Create an unmanaged iceberg table from Iceberg REST

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables:from-iceberg-rest
Create an unmanaged iceberg table from Iceberg REST

Response

CodeDescription
200
202

Describe iceberg table

GET/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}
Describe an iceberg table

Path Parameters

ParameterDescription
name 
Identifier (i.e. name) for the resource.

Response

CodeDescription
200
successful
202

Drop iceberg table

DELETE/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}
Drop an iceberg table

Query Parameters

ParameterDescription
ifExists boolean
Parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.
type string
Specifies whether the table can be dropped if foreign keys exist that reference the table.

Response

CodeDescription
200
202

Resume recluster of an iceberg table

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:resume-recluster
Resume recluster of an iceberg table (iceberg tables managed by an external catalog do not allow clustering)

Response

CodeDescription
200
202

Suspend recluster of an iceberg table

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:suspend-recluster
Suspend recluster of an iceberg table (iceberg tables managed by an external catalog do not allow clustering)

Response

CodeDescription
200
202

Refreshes the metadata for an Apache Iceberg table that uses an external Iceberg catalog

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:refresh
Refreshes the metadata for an Apache Iceberg table that uses an external Iceberg catalog

Response

CodeDescription
200
202

Converts an Apache Iceberg™ table that uses an external Iceberg catalog into a table that uses Snowflake as the catalog

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:convert-to-managed
Convert unmanaged iceberg table to managed iceberg table

Response

CodeDescription
200
202

Undrop iceberg table

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:undrop
Undrop an iceberg table

Response

CodeDescription
200
202

Clone a snowflake managed iceberg table

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:clone
Clone a snowflake managed iceberg table

Query Parameters

ParameterDescription
targetDatabase string
Database of the newly created table. Defaults to the source table's database.
targetSchema 
Schema of the newly created table. Defaults to the source table's schema.

Response

CodeDescription
200
202

Create iceberg table like

POST/api/v2/databases/{database}/schemas/{schema}/iceberg-tables/{name}:create-like
Creates a new table with the same column definitions as an existing table, but without copying data from the existing table.

Query Parameters

ParameterDescription
targetDatabase 
Database of the newly created table. Defaults to the source table's database.
targetSchema 
Schema of the newly created table. Defaults to the source table's schema.

Response

CodeDescription
200
202
Language: English