Iceberg Ingest

Remarks

The following are supported:

Iceberg Version 1 tables and Iceberg Version 2 tables with data files in Parquet format.
Iceberg tables stored in Amazon S3 with catalogs: GLUE, Snowflake, REST, JDBC, Hive, and Polaris.
Initial load of Iceberg tables and continuous ingest of updates to Iceberg tables.

Syntax

SQL

CREATE [OR REPLACE] PIPELINE <pipeline_name> AS
LOAD DATA S3 '[<warehouse_path>]'
CONFIG '{"catalog_type": "GLUE|SNOWFLAKE|REST|JDBC |HIVE",
        "table_id": "<table_identifier>",
        <configuration_json>  
        [, "ingest_mode": "append|upsert|one_time"]
        [, "catalog_name": "<your_catalog_name>" ]
        [, “catalog.<property>” : “property_value” [, …]]
}'
CREDENTIALS '<credentials_json>’
[REPLACE] INTO TABLE <table_name>
[ON DUPLICATE KEY UPDATE]      
<iceberg_subvalue_mapping>
FORMAT ICEBERG;

<iceberg_subvalue_mapping>:(
{<singlestore_col_name> | @<variable_name>}<- <iceberg_subvalue_path> [, ... ])

<iceberg_subvalue_path>: {ident [::ident ...]}

The warehouse_path specifies the path to the catalog warehouse. It is required for the JDBC catalog. The warehouse_path can be set to an empty string when not needed.

All the data shaping options for Parquet pipelines are supported for Iceberg pipelines. Refer to Data Shaping with Pipelines for more information.

Catalog Specification

The catalog_type and table_id are required for the catalog specification.
The table_id identifies the Iceberg table. The table identifier is catalog-specific, but is typically in the form: database_name.table_name.
The catalog_name is a name to associate with the catalog when reading table metadata and is used internally in SingleStore for logging and metrics purposes. The catalog_name is required for the JDBC catalog and is optional for other catalogs.
The catalog.property is a list of key-value pairs for configuring the catalog connection. The property and value are passed directly to the Iceberg SDK to establish the catalog connection.

S3 Specification

The configuration_json is a JSON string for S3 configuration parameters such as region, endpoint_url, and compatibility_mode. Refer to CREATE PIPELINE and CREATE LINK for more information.
The credentials_json is an AWS credential specification in JSON which includes fields such as aws_access_key_id and aws_secret_access_key. Refer to CREATE LINK for more information.

Ingest Mode

Three ingest modes are supported: one_time for one-time loads, and two modes for continuous ingest: append for append-only workloads and upsert for upsert workloads. The default ingest_mode is append.
With continuous ingest ("ingest_mode":"append" or "ingest_mode":"upsert"), a running pipeline automatically detects updates to the Iceberg table and ingests them into the SingleStore table. Refer to Continuous Ingest for details on append and upsert mode.
In one-time ingest ("ingest_mode":"one_time") SingleStore will request Iceberg table metadata and load data from the latest snapshot available at that moment. Subsequent updates to the Iceberg table are not automatically ingested.
The ingest mode is specified by setting ingest_mode in the pipeline specification as shown in the syntax above.

Subvalue Mappings

The iceberg_subvalue_mapping assigns fields from the Iceberg table to columns in the SingleStore table or to temporary variables. A ::-separated list of field names is used in iceberg_subvalue_path to look up fields in nested schemas. When the files in the Iceberg table are Parquet files, the ::-separated list of field names is used to look up fields in nested Parquet schemas. The following rules apply:

The last field in iceberg_subvalue_path must be a primitive type.
All iceberg_subvalue_path components containing whitespace or punctuation must be surrounded by backticks (`).
The iceberg_subvalue_path may not contain Parquet nested types (list or map types). Refer to Parquet - Nested Types for more information.

Enable and Configure Iceberg Ingest

The global engine variable enable_iceberg_ingest must be set to ON to use Iceberg ingest. This variable is set to OFF by default.

SQL

SET GLOBAL enable_iceberg_ingest = ON;

Three additional variables are available to tune Iceberg ingest pipelines: pipelines_extractor_get_offsets_timeout_ms, pipelines_extractor_idle_timeout_ms, and pipelines_iceberg_heap_size. In most cases, SingleStore recommends using the default values of these variables.

To avoid timeout errors during pipeline creation or execution, set pipelines_extractor_get_offsets_timeout_ms and pipelines_extractor_idle_timeout_ms to values higher than 5 minutes to provide an adequate amount of time to process the Iceberg catalog and data. To avoid out of memory errors, increase the value of pipelines_iceberg_heap_size.

Refer to List of Engine Variables for more information.

Continuous Ingest

With continuous ingestion, a running pipeline automatically detects updates to an Iceberg table and ingests them into the SingleStore table.

Continuous Ingest - Append-Only

Append-only mode is the default and is used for scenarios in which new rows are added to the Iceberg table, but no rows are deleted or modified.

In append-only mode ("ingest_mode":"append") the pipeline will processes APPEND Iceberg snapshots. If a non-APPEND snapshot is encountered, an error is raised. Users may override those errors by specifying "ignore_unsupported_modifications"=true in the pipeline configuration. SingleStore does not recommend setting "ignore_unsupported_modifications"=true as doing so may lead to data inconsistency.

Continuous Ingest - Upsert

Upsert mode is used for scenarios where updates modify non-key columns based on a specified key column(s). An upsert is an insert and update, an upsert updates a row in the table if there is a primary key match or inserts the row if there is no primary key match.

In upsert mode ("ingest_mode":"upsert"), the pipeline will process updates to the Iceberg table as upserts to the SingleStore table. That is, the pipeline will process Iceberg APPEND and OVERWRITE snapshots of the Iceberg table as upserts to the SingleStore table.

Requirements:

The SingleStore table must have a primary key or a unique index. In the <iceberg_subvalue_mapping>, a column(s) in the Iceberg table must be mapped to the column(s) in SingleStore on which there is a key or unique index. Typically that column(s) in the Iceberg table will also be declared as a key.
The pipeline must be created using REPLACE. Refer to Additional CREATE PIPELINE Examples for more information.

Limitations:

Pipelines will fail on delete snapshots. Users may override these errors by specifying "ignore_unsupported_modifications"=true in the pipeline configuration. SingleStore does not recommend setting "ignore_unsupported_modifications"=true as doing so may lead to data inconsistency.
Limitations are expected to be addressed in future releases.

Ingest Data Type Mapping

The table below lists Iceberg Types, the SingleStore data type that can be used to store those types, and the recommended conversion to be applied with a SET clause.

Iceberg Type	Recommended SingleStore Data Type	Recommended Conversion
boolean	`TINYINT`/`BOOL`/`BOOLEAN`
int	`INT`
long	`BIGINT`
float	`FLOAT`
double	`DOUBLE`
decimal(P,S)	`DECIMAL`
date	`DATE`	DATE_ADD('1970-01-01', INTERVAL @date DAY)
time	`TIME(6)`	DATE_ADD('1970-01-01', INTERVAL @time_value MICROSECOND)
timestamp	`DATETIME(6)`	DATE_ADD('1970-01-01', INTERVAL @timestamp_value MICROSECOND)
timestamptz	`DATETIME(6)`	DATE_ADD('1970-01-01', INTERVAL @timestamp_value MICROSECOND)
string	`LONGTEXT (utf8mb4_bin)`
uuid	`BINARY(16)`
fixed (L)	`BINARY(L)`
binary	`LONGBLOB`

CREATE OR REPLACE

When a pipeline with a specified pipeline_name already exists, the CREATE OR REPLACE command functions similarly to CREATE_PIPELINE, with the added benefit of preserving existing pipeline metadata, such as loaded offsets and data files. Running CREATE OR REPLACE on an existing pipeline initiates the Iceberg pipeline to retrieve a new snapshot, schema, and data files, and inserts data from these new files into the destination table in SingleStore.

Executing CREATE OR REPLACE on an existing Iceberg pipeline may cause some data files to be ingested twice. To avoid this, use CREATE OR REPLACE only with REPLACE INTO statements or in an upsert configuration.

SQL

CREATE PIPELINE books_create_pipe AS
LOAD DATA S3 ''
CONFIG '{"region":"us-west-2",
        "catalog_type": "GLUE",
        "catalog_name": "s3_catalog",
        "table_id": "db.books",
        "ingest_mode": "one_time"
}'
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
REPLACE INTO TABLE books
  (Id <- id,
  Name <- name,
  NumPages <- numPages,
  Rating <- rating)
FORMAT ICEBERG;

Refer to CREATE PIPELINE for syntax for CREATE OR REPLACE PIPELINE, REPLACE INTO TABLE, and ON DUPLICATE KEY UPDATE. Refer to Performing Upserts for more information on upserts.

Example - Glue Catalog on Amazon S3

An Iceberg table with data files in Parquet format that is stored in an AWS S3 bucket using AWS Glue can be loaded into a SingleStore table using a pipeline (CREATE PIPELINE. Refer to Apache Iceberg - Glue Catalog for information on using a GLUE catalog with Iceberg.

In this example, a table named books is created and data from an Iceberg table that meets this schema is loaded into the books table.

Create the table.

SQL

CREATE TABLE books(
  Id INT,
  Name TEXT,
  NumPages INT,
  Rating DOUBLE,
  PRIMARY KEY(Id));

The following data is used for this example.

Shell

(1, 'Happy Place', 400, 4.9)
(2, 'Legends & Lattes', 304, 4.9)
(3, 'The Vanishing Half', 352, 4.9)
(4, 'The Wind Knows My Name', 304, 4.9)

The PIPELINE statement below will load data from an Iceberg table containing the data above into the books table. The column names on the left side of the <- are the column names from the SingleStore table into which the data will be loaded. The column names on the right side of the <- are the column names from the Iceberg table which is to be loaded into SingleStore.

SQL

CREATE PIPELINE books_pipe AS
LOAD DATA S3 ''
CONFIG '{"region":"us-west-2",
         "catalog_type": "GLUE", 
         "table_id": "db.books"
}' 
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
              "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE books
   (Id <- id,
   Name <- name,
   NumPages <- numPages,
   Rating <- rating)
FORMAT ICEBERG;

Test the pipeline.

SQL

TEST PIPELINE books_pipe;

+------+------------------------+----------+--------+
| Id   | Name                   | NumPages | Rating |
+------+------------------------+----------+--------+
|    4 | The Wind Knows My Name |      304 |    4.9 |
|    1 | Happy Place            |      400 |    4.9 |
|    2 | Legends & Lattes       |      304 |    4.9 |
|    3 | The Vanishing Half     |      352 |    4.9 |
+------+------------------------+----------+--------+

Refer to START PIPELINE for more information on starting pipelines.

Example - Use Subvalue Mappings

This example shows the use of subvalue mappings to load nested elements from an Iceberg schema into a SingleStore table.

Create a table.

SQL

CREATE TABLE addresses(
Id INT,
Name TEXT,
Street TEXT,
City TEXT,
Country TEXT,
PRIMARY KEY(Id));

The following data is used for this example.

Shell

(1, 'Mylo', struct('123 Main St', 'New York', 'USA'))
(2, 'Naya', struct('456 Elm St', 'San Francisco', 'USA'))

The PIPELINE statement below will load data from an Iceberg table containing the data above into the addresses table. The column names on the left side of the <- are the column names from the SingleStore table into which the data will be loaded. The column names on the right side of the <- are the column names from the Iceberg table which is to be loaded into SingleStore.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 ''
CONFIG '{"region":"us-west-2",
         "catalog_type": "GLUE", 
         "catalog_name": "s3_catalog", 
         "table_id": "db2.addresses"
}' 
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
              "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
   (Id <- id,
   Name <- name,
   Street <- address::street,
   City <- address::city,
   Country <- address::country)
FORMAT ICEBERG;

The CREDENTIALS may also contain an aws_session_token; refer to CREATE LINK for more information.

Test the pipeline.

SQL

TEST PIPELINE addresses_pipe;

+------+------+-------------+---------------+---------+
| Id   | Name | Street      | City          | Country |
+------+------+-------------+---------------+---------+
|    1 | Mylo | 123 Main St | New York      | USA     |
|    2 | Naya | 456 Elm St  | San Francisco | USA     |
+------+------+-------------+---------------+---------+

Refer to START PIPELINE for more information on starting pipelines.

Example - Snowflake Catalog on Amazon S3

Ingest an Iceberg table stored in Amazon S3 with a Snowflake catalog.

Iceberg tables to be ingested in SingleStore must be created on an external volume. Refer to Tutorial: Create your first Iceberg table , Create an external volume , and Snowflake Iceberg Catalog SDK for more information.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 ''
CONFIG '{"region" : "us-west-2",
        "catalog_type": "SNOWFLAKE",
        "table_id": "db_name.schema_name.table_name",
        "catalog.uri": "jdbc:snowflake://<acount_identifier>.snowflakecomputing.com",
        "catalog.jdbc.user":"<user_name>",
        "catalog.jdbc.password":"<password>",
        "catalog.jdbc.role":"<user role>"}'
CREDENTIALS '{"aws_access_key_id" : "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
  (Id <- id,
  Name <- name,
  Street <- address::street,
  City <- address::city,
  Country <- address::country)
FORMAT ICEBERG;

For the Snowflake catalog, the table_id must consist of three parts - the database name, the schema name, and the table name. In addition, the catalog.uri, catalog.jdbc.user, catalog.jdbc.password, and catalog.jdbc.role are required.

Example - REST Catalog on Amazon S3

Ingest an Iceberg table stored in Amazon S3 with REST catalog. Refer to Decoupling using the REST Catalog for information on using a REST catalog with Iceberg.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 ''
CONFIG '{"region" : "us-west-2",
        "catalog_type": "REST",
        "table_id": "db_name.table_name",
        "catalog.uri": "http://host.addresss:8181"}'
CREDENTIALS '{"aws_access_key_id" : "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
  (Id <- id,
  Name <- name,
  Street <- address::street,
  City <- address::city,
  Country <- address::country)
FORMAT ICEBERG;

Example - JDBC Catalog on Amazon S3

Ingest an Iceberg table stored in Amazon S3 with JDBC catalog. Refer to Iceberg JDBC Integration for more information on using Iceberg with JDBC catalog.

SingleStore supports Postgres, MySQL, and SQLite JDBC drivers by default.

The following example uses JDBC with SQLite.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 's3://path_to_warehouse'
CONFIG '{"region" : "us-west-2",
        "catalog_type": "JDBC",
        "catalog_name": "catalog_name",
        "table_id": "db_name.table_name",
        "catalog.uri":"jdbc:sqlite_:file:/path_jdbc"}'
CREDENTIALS '{"aws_access_key_id" : "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
  (Id <- id,
  Name <- name,
  Street <- address::street,
  City <- address::city,
  Country <- address::country)
FORMAT ICEBERG;

The following example uses JDBC with MySQL.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 's3://path_to_warehouse'
CONFIG '{"region" : "us-west-2",
        "catalog_type": "JDBC",
        "catalog_name": "catalog_name",
        "table_id": "db_name.table_name",
        "catalog.uri": "jdbc:mysql://host.address:3306/default",
        "catalog.jdbc.user": "<user_name>",
        "catalog.jdbc.password": "<password>"}'
CREDENTIALS '{"aws_access_key_id" : "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
  (Id <- id, 
   Name <- name, 
   Country <- address::country)
FORMAT ICEBERG;

The path_to_warehouse and catalog_name are required for JDBC catalogs.

Example - Hive Catalog on Amazon S3

Ingest an Iceberg table stored in Amazon S3 using Hive Catalog. Iceberg tables to be ingested in the Hive catalog must use Hive Metastore service. Refer to Apache Hive and Hive - Apache Iceberg for more information.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 ''
CONFIG '{"catalog_type": "HIVE",
         "catalog.uri": "thrift://<service_endpoint>:46590",
         "region": "us-east-1",
         "catalog.hive.metastore.client.auth.mode": "PLAIN",
         "catalog.hive.metastore.client.plain.username": "<username>",
         "catalog.hive.metastore.client.plain.password": "<password>",
         "catalog.metastore.use.SSL": "true",
         "catalog.hive.metastore.truststore.type": "PKCS12", 
         "catalog.hive.metastore.truststore.path": "/path/to/your/project/hive/truststore.12"
         "catalog.hive.metastore.truststore.password": <truststore_password>
}'
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
              "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
 (Id <- id,
 Name <- name,
 Street <- address::street,
 City <- address::city,
 Country <- address::country)
FORMAT ICEBERG;

The catalog.uri is the base URL for accessing the Hive catalog's API or service endpoint.

The catalog.hive.metastore.client.auth.mode is the authentication mode for connecting to the Hive Metastore.

The catalog.hive.metastore.client.plain.username is the username used to authenticate with the Hive Metastore.

The catalog.hive.metastore.client.plain.password is the password for the authenticated user.

The catalog.metastore.use.SSL is a boolean flag that secures communication with the Hive Metastore.

The catalog.hive.metastore.truststore.type is the truststore format used to validate the SSL certificate.

The catalog.hive.metastore.truststore.path is the file path that contains the SSL certificate.

The catalog.hive.metastore.truststore.password is the password needed to access the truststore.

Refer to GitHub for additional Hive configurations.

Example - Polaris Catalog on Amazon S3

Ingest an Iceberg table stored in Amazon S3 using Polaris Catalog. Polaris catalog uses the Apache Iceberg REST API. Refer to Getting Started with Snowflake Open Catalog for more information.

SQL

CREATE PIPELINE addresses_pipe AS
LOAD DATA S3 ''
CONFIG '{"catalog_type": "REST",
        "catalog.warehouse": "<polaris_catalog_name>",
        "table_id": "db_name.table_name",
        "region":"us-east-1",
        "catalog.uri":"https://<account_identifier>.snowflakecomputing.com/polaris/api/catalog",
        "region":"us-east-1",
        "catalog.connection":"<polaris_catalog_secret_key>",
        "catalog.scope": "PRINCIPAL_ROLE:ALL"}'
CREDENTIALS '{"aws_access_key_id" : "<your_access_key_id>",
           "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE addresses
(Id <- id,
Name <- name,
Street <- address::street,
City <- address::city,
Country <- address::country)
FORMAT ICEBERG;

The catalog.uri is the base URL for accessing the Polaris catalog's API or service endpoint.

The catalog.scope defines the access permissions for the Polaris catalog.

The catalog.connection is a secret key from Polaris catalog connection, formatted as <ClientID>:<Secret>. Get this when you configure the service connection in Snowflake while creating a connection for a Polaris catalog.

Example - Continuous Ingest - Upsert Mode

The example below shows a pipeline using ingest_mode of upsert. As required when ingest_mode is upsert, the books table has a primary key, Id, in this example.

When started, this pipeline will ingest data from the latest snapshot of the Iceberg table into the SingleStore books table. Then, when the Iceberg table is updated, those updates will automatically be applied to the SingleStore table as upserts.

SQL

CREATE PIPELINE books_upsert_pipe AS
LOAD DATA S3 ''
CONFIG '{"region":"us-west-2",
        "catalog_type": "GLUE",
        "catalog_name": "s3_catalog",
        "table_id": "db.books",
        "ingest_mode": "upsert"
}'
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
REPLACE INTO TABLE books
  (Id <- id,
  Name <- name,
  NumPages <- numPages,
  Rating <- rating)
FORMAT ICEBERG;

Example - Continuous Ingest - Append Mode

The example below shows a pipeline using ingest_mode of append.

When started, this pipeline will ingest data from the latest snapshot of the Iceberg table into the SingleStore books table. Then, when the Iceberg table is updated, any appends to that table will automatically be appended to the SingleStore table. If non-append updates are encountered, an error will be thrown.

SQL

CREATE PIPELINE books_append_pipe AS
LOAD DATA S3 ''
CONFIG '{"region":"us-west-2",
        "catalog_type": "GLUE",
        "catalog_name": "s3_catalog",
        "table_id": "db.books",
        "ingest_mode": "append"
}'
CREDENTIALS '{"aws_access_key_id": "<your_access_key_id>",
             "aws_secret_access_key": "<your_secret_access_key>"}'
INTO TABLE books
  (Id <- id,
  Name <- name,
  NumPages <- numPages,
  Rating <- rating)
FORMAT ICEBERG;

On this page

Remarks

Syntax

Catalog Specification

S3 Specification

Ingest Mode

Subvalue Mappings

Enable and Configure Iceberg Ingest

Continuous Ingest

Continuous Ingest - Append-Only

Continuous Ingest - Upsert

Ingest Data Type Mapping

CREATE OR REPLACE

Example - Glue Catalog on Amazon S3

Example - Use Subvalue Mappings

Example - Snowflake Catalog on Amazon S3

Example - REST Catalog on Amazon S3

Example - JDBC Catalog on Amazon S3

Example - Hive Catalog on Amazon S3

Example - Polaris Catalog on Amazon S3

Example - Continuous Ingest - Upsert Mode

Example - Continuous Ingest - Append Mode

Was this article helpful?

On this page

Was this article helpful?

Iceberg Ingest

On this page

Remarks

Syntax

Catalog Specification

S3 Specification

Ingest Mode

Subvalue Mappings

Enable and Configure Iceberg Ingest

Continuous Ingest

Continuous Ingest - Append-Only

Continuous Ingest - Upsert

Ingest Data Type Mapping

CREATE OR REPLACE

Example - Glue Catalog on Amazon S3

Example - Use Subvalue Mappings

Example - Snowflake Catalog on Amazon S3

Example - REST Catalog on Amazon S3

Example - JDBC Catalog on Amazon S3

Example - Hive Catalog on Amazon S3

Example - Polaris Catalog on Amazon S3

Example - Continuous Ingest - Upsert Mode

Example - Continuous Ingest - Append Mode

Related Topics

Was this article helpful?

On this page

Was this article helpful?