iceberg::sql Namespace Reference

SQL catalog APIs. More...

Classes
class	CatalogStore
	Semantic, driver-agnostic storage interface for the SQL catalog. More...
struct	CatalogStoreOptions
	Connection parameters used to construct a built-in CatalogStore. More...
struct	NamespaceProperty
	A namespace property row. More...
class	SqlCatalog
	SQL-backed Iceberg catalog. More...
struct	SqlCatalogConfig
	Configuration for the SQL catalog. More...

Functions
ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > >	MakeSqliteCatalogStore (const CatalogStoreOptions &options)
	Build the built-in SQLite catalog store (sqlpp23 + SQLite3).
ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > >	MakePostgreSqlCatalogStore (const CatalogStoreOptions &options)
	Build the built-in PostgreSQL catalog store (sqlpp23 + libpq).
ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > >	MakeMySqlCatalogStore (const CatalogStoreOptions &options)
	Build the built-in MySQL catalog store (sqlpp23 + libmysqlclient).

Detailed Description

SQL catalog APIs.

Function Documentation

MakeMySqlCatalogStore()

ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > > iceberg::sql::MakeMySqlCatalogStore

(

const CatalogStoreOptions &

options

)

Build the built-in MySQL catalog store (sqlpp23 + libmysqlclient).

options.uri is parsed as [scheme://][user[:password]@]host[:port][/database].

Parameters

options

Store connection options.

Returns

A catalog store instance, or ErrorKind::kNotSupported if the MySQL connector was not built.

MakePostgreSqlCatalogStore()

ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > > iceberg::sql::MakePostgreSqlCatalogStore

(

const CatalogStoreOptions &

options

)

Build the built-in PostgreSQL catalog store (sqlpp23 + libpq).

options.uri is parsed as [scheme://][user[:password]@]host[:port][/database].

Parameters

options

Store connection options.

Returns

A catalog store instance, or ErrorKind::kNotSupported if the PostgreSQL connector was not built.

MakeSqliteCatalogStore()

ICEBERG_SQL_CATALOG_EXPORT Result< std::shared_ptr< CatalogStore > > iceberg::sql::MakeSqliteCatalogStore

(

const CatalogStoreOptions &

options

)

Build the built-in SQLite catalog store (sqlpp23 + SQLite3).

options.uri is the SQLite database file path, or ":memory:".

Parameters

options

Store connection options.

Returns

A catalog store instance, or ErrorKind::kNotSupported if the SQLite connector was not built.