SQL-backed Iceberg catalog. More...

#include <sql_catalog.h>

Inheritance diagram for iceberg::sql::SqlCatalog:

Public Member Functions
	SqlCatalog (const SqlCatalog &)=delete

SqlCatalog &	operator= (const SqlCatalog &)=delete

	SqlCatalog (SqlCatalog &&)=delete

SqlCatalog &	operator= (SqlCatalog &&)=delete

std::string_view	name () const override
	Return the name for this catalog.

Status	CreateNamespace (const Namespace &ns, const std::unordered_map< std::string, std::string > &properties) override
	Create a namespace with associated properties.

Result< std::vector< Namespace > >	ListNamespaces (const Namespace &ns) const override
	List child namespaces from the given namespace.

Result< std::unordered_map< std::string, std::string > >	GetNamespaceProperties (const Namespace &ns) const override
	Get metadata properties for a namespace.

Status	DropNamespace (const Namespace &ns) override
	Drop a namespace.

Result< bool >	NamespaceExists (const Namespace &ns) const override
	Check whether the namespace exists.

Status	UpdateNamespaceProperties (const Namespace &ns, const std::unordered_map< std::string, std::string > &updates, const std::unordered_set< std::string > &removals) override
	Update a namespace's properties by applying additions and removals.

Result< std::vector< TableIdentifier > >	ListTables (const Namespace &ns) const override
	Return all the identifiers under this namespace.

Result< std::shared_ptr< Table > >	CreateTable (const TableIdentifier &identifier, const std::shared_ptr< Schema > &schema, const std::shared_ptr< PartitionSpec > &spec, const std::shared_ptr< SortOrder > &order, const std::string &location, const std::unordered_map< std::string, std::string > &properties) override
	Create a table.

Result< std::shared_ptr< Table > >	UpdateTable (const TableIdentifier &identifier, const std::vector< std::unique_ptr< TableRequirement > > &requirements, const std::vector< std::unique_ptr< TableUpdate > > &updates) override
	Update a table.

Result< std::shared_ptr< Transaction > >	StageCreateTable (const TableIdentifier &identifier, const std::shared_ptr< Schema > &schema, const std::shared_ptr< PartitionSpec > &spec, const std::shared_ptr< SortOrder > &order, const std::string &location, const std::unordered_map< std::string, std::string > &properties) override
	Start a transaction to create a table.

Result< bool >	TableExists (const TableIdentifier &identifier) const override
	Check whether table exists.

Status	DropTable (const TableIdentifier &identifier, bool purge) override
	Drop a table.

Status	RenameTable (const TableIdentifier &from, const TableIdentifier &to) override
	Rename a table.

Result< std::shared_ptr< Table > >	LoadTable (const TableIdentifier &identifier) override
	Load a table.

Result< std::shared_ptr< Table > >	RegisterTable (const TableIdentifier &identifier, const std::string &metadata_file_location) override
	Register a table with the catalog if it does not exist.

Static Public Member Functions
static Result< std::shared_ptr< SqlCatalog > >	Make (const SqlCatalogConfig &config, std::shared_ptr< FileIO > file_io, std::shared_ptr< CatalogStore > store)
	Create a catalog backed by a user-supplied `CatalogStore`.

static Result< std::shared_ptr< SqlCatalog > >	MakeSqliteCatalog (const SqlCatalogConfig &config, std::shared_ptr< FileIO > file_io)
	Create a catalog backed by the built-in SQLite client.

static Result< std::shared_ptr< SqlCatalog > >	MakePostgreSqlCatalog (const SqlCatalogConfig &config, std::shared_ptr< FileIO > file_io)
	Create a catalog backed by the built-in PostgreSQL (libpq) client.

static Result< std::shared_ptr< SqlCatalog > >	MakeMySqlCatalog (const SqlCatalogConfig &config, std::shared_ptr< FileIO > file_io)
	Create a catalog backed by the built-in MySQL client.

Detailed Description

SQL-backed Iceberg catalog.

Member Function Documentation

◆ CreateNamespace()

Status iceberg::sql::SqlCatalog::CreateNamespace	(	const Namespace &	ns,
		const std::unordered_map< std::string, std::string > &	properties
	)

overridevirtual

Create a namespace with associated properties.

Parameters

ns	the namespace to create
properties	a key-value map of metadata for the namespace

Returns: Status indicating success if created successfully; ErrorKind::kAlreadyExists if the namespace already exists; ErrorKind::kNotSupported if the operation is not supported

Implements iceberg::Catalog.

◆ CreateTable()

Result< std::shared_ptr< Table > > iceberg::sql::SqlCatalog::CreateTable	(	const TableIdentifier &	identifier,
		const std::shared_ptr< Schema > &	schema,
		const std::shared_ptr< PartitionSpec > &	spec,
		const std::shared_ptr< SortOrder > &	order,
		const std::string &	location,
		const std::unordered_map< std::string, std::string > &	properties
	)

overridevirtual

Create a table.

Parameters

identifier	a table identifier
schema	a schema
spec	a partition spec
order	a sort order
location	a location for the table; leave empty if unspecified
properties	a string map of table properties

Returns: a Table instance or ErrorKind::kAlreadyExists if the table already exists

Implements iceberg::Catalog.

◆ DropNamespace()

Status iceberg::sql::SqlCatalog::DropNamespace ( const Namespace & ns )

overridevirtual

Drop a namespace.

Parameters

ns	the namespace to drop

Returns: Status indicating success if dropped successfully; ErrorKind::kNoSuchNamespace if the namespace does not exist; ErrorKind::kNotAllowed if the namespace is not empty

Implements iceberg::Catalog.

◆ DropTable()

Status iceberg::sql::SqlCatalog::DropTable	(	const TableIdentifier &	identifier,
		bool	purge
	)

overridevirtual

Drop a table.

SqlCatalog currently removes only the catalog entry. Support for deleting table data and metadata files when purge is true is not implemented yet.

Implements iceberg::Catalog.

◆ GetNamespaceProperties()

Result< std::unordered_map< std::string, std::string > > iceberg::sql::SqlCatalog::GetNamespaceProperties ( const Namespace & ns ) const

overridevirtual

Get metadata properties for a namespace.

Parameters

ns	the namespace to look up

Returns: a key-value map of metadata properties; ErrorKind::kNoSuchNamespace if the namespace does not exist

Implements iceberg::Catalog.

◆ ListNamespaces()

Result< std::vector< Namespace > > iceberg::sql::SqlCatalog::ListNamespaces ( const Namespace & ns ) const

overridevirtual

List child namespaces from the given namespace.

Parameters

ns	the parent namespace

Returns: a list of child namespaces; ErrorKind::kNoSuchNamespace if the given namespace does not exist

Implements iceberg::Catalog.

◆ ListTables()

Result< std::vector< TableIdentifier > > iceberg::sql::SqlCatalog::ListTables ( const Namespace & ns ) const

overridevirtual

Return all the identifiers under this namespace.

Parameters

ns	a namespace

Returns: a list of identifiers for tables or ErrorKind::kNoSuchNamespace if the namespace does not exist

Implements iceberg::Catalog.

◆ LoadTable()

Result< std::shared_ptr< Table > > iceberg::sql::SqlCatalog::LoadTable ( const TableIdentifier & identifier )

overridevirtual

Load a table.

Parameters

identifier a table identifier

Returns: instance of Table implementation referred to by identifier or ErrorKind::kNoSuchTable if the table does not exist

Implements iceberg::Catalog.

◆ Make()

Result< std::shared_ptr< SqlCatalog > > iceberg::sql::SqlCatalog::Make	(	const SqlCatalogConfig &	config,
		std::shared_ptr< FileIO >	file_io,
		std::shared_ptr< CatalogStore >	store
	)

static

Create a catalog backed by a user-supplied CatalogStore.

This is the extension point for custom databases/drivers: implement CatalogStore and pass it here. The catalog initializes its schema (creating the backing tables if they do not exist) before returning.

Parameters

config	Catalog configuration (name and warehouse location are used; `uri` is informational because the store is already constructed).
file_io	File IO used to read and write table metadata files.
store	The catalog metadata store. Must not be null.

◆ MakeMySqlCatalog()

Result< std::shared_ptr< SqlCatalog > > iceberg::sql::SqlCatalog::MakeMySqlCatalog	(	const SqlCatalogConfig &	config,
		std::shared_ptr< FileIO >	file_io
	)

static

Create a catalog backed by the built-in MySQL client.

Parameters

config	`uri` is parsed as `[scheme://][user[:password]@]host[:port][/database]`.
file_io	File IO used to read and write table metadata files.

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

◆ MakePostgreSqlCatalog()

Result< std::shared_ptr< SqlCatalog > > iceberg::sql::SqlCatalog::MakePostgreSqlCatalog	(	const SqlCatalogConfig &	config,
		std::shared_ptr< FileIO >	file_io
	)

static

Create a catalog backed by the built-in PostgreSQL (libpq) client.

Parameters

config	`uri` is parsed as `[scheme://][user[:password]@]host[:port][/database]`.
file_io	File IO used to read and write table metadata files.

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

◆ MakeSqliteCatalog()

Result< std::shared_ptr< SqlCatalog > > iceberg::sql::SqlCatalog::MakeSqliteCatalog	(	const SqlCatalogConfig &	config,
		std::shared_ptr< FileIO >	file_io
	)

static

Create a catalog backed by the built-in SQLite client.

Parameters

config	`uri` is the SQLite database file path (or ":memory:").
file_io	File IO used to read and write table metadata files.

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

◆ name()

std::string_view iceberg::sql::SqlCatalog::name ( ) const

overridevirtual

Return the name for this catalog.

Implements iceberg::Catalog.

◆ NamespaceExists()

Result< bool > iceberg::sql::SqlCatalog::NamespaceExists ( const Namespace & ns ) const

overridevirtual

Check whether the namespace exists.

Parameters

ns	the namespace to check

Returns: true if the namespace exists, false otherwise

Implements iceberg::Catalog.

◆ RegisterTable()

Result< std::shared_ptr< Table > > iceberg::sql::SqlCatalog::RegisterTable	(	const TableIdentifier &	identifier,
		const std::string &	metadata_file_location
	)

overridevirtual

Register a table with the catalog if it does not exist.

Parameters

identifier	a table identifier
metadata_file_location	the location of a metadata file

Returns: a Table instance or ErrorKind::kAlreadyExists if the table already exists

Implements iceberg::Catalog.

◆ RenameTable()

Status iceberg::sql::SqlCatalog::RenameTable	(	const TableIdentifier &	from,
		const TableIdentifier &	to
	)

overridevirtual

Rename a table.

Parameters

from	the current table identifier
to	the new table identifier

Returns

Status indicating the outcome of the operation.

On success, the table was renamed.
On failure, contains error information.

Implements iceberg::Catalog.

◆ StageCreateTable()

Result< std::shared_ptr< Transaction > > iceberg::sql::SqlCatalog::StageCreateTable	(	const TableIdentifier &	identifier,
		const std::shared_ptr< Schema > &	schema,
		const std::shared_ptr< PartitionSpec > &	spec,
		const std::shared_ptr< SortOrder > &	order,
		const std::string &	location,
		const std::unordered_map< std::string, std::string > &	properties
	)

overridevirtual

Start a transaction to create a table.

Parameters

identifier	a table identifier
schema	a schema
spec	a partition spec
order	a sort order
location	a location for the table; leave empty if unspecified
properties	a string map of table properties

Returns: a Transaction to create the table or ErrorKind::kAlreadyExists if the table already exists

Implements iceberg::Catalog.

◆ TableExists()

Result< bool > iceberg::sql::SqlCatalog::TableExists ( const TableIdentifier & identifier ) const

overridevirtual

Check whether table exists.

Parameters

identifier a table identifier

Returns

Result<bool> indicating table exists or not.

On success, the table existence was successfully checked (actual existence may be inferred elsewhere).
On failure, contains error information.

Implements iceberg::Catalog.

◆ UpdateNamespaceProperties()

Status iceberg::sql::SqlCatalog::UpdateNamespaceProperties	(	const Namespace &	ns,
		const std::unordered_map< std::string, std::string > &	updates,
		const std::unordered_set< std::string > &	removals
	)

overridevirtual

Update a namespace's properties by applying additions and removals.

Parameters

ns	the namespace to update
updates	a set of properties to add or overwrite
removals	a set of property keys to remove

Returns: Status indicating success if the update is successful; ErrorKind::kNoSuchNamespace if the namespace does not exist; ErrorKind::kUnsupported if the operation is not supported

Implements iceberg::Catalog.

◆ UpdateTable()

Result< std::shared_ptr< Table > > iceberg::sql::SqlCatalog::UpdateTable	(	const TableIdentifier &	identifier,
		const std::vector< std::unique_ptr< TableRequirement > > &	requirements,
		const std::vector< std::unique_ptr< TableUpdate > > &	updates
	)

overridevirtual

Update a table.

Parameters

identifier	a table identifier
requirements	a list of table requirements
updates	a list of table updates

Returns: a Table instance or ErrorKind::kAlreadyExists if the table already exists

Implements iceberg::Catalog.

The documentation for this class was generated from the following files:

iceberg/catalog/sql/sql_catalog.h
iceberg/catalog/sql/sql_catalog.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateNamespace()

◆ CreateTable()

◆ DropNamespace()

◆ DropTable()

◆ GetNamespaceProperties()

◆ ListNamespaces()

◆ ListTables()

◆ LoadTable()

◆ Make()

◆ MakeMySqlCatalog()

◆ MakePostgreSqlCatalog()

◆ MakeSqliteCatalog()

◆ name()

◆ NamespaceExists()

◆ RegisterTable()

◆ RenameTable()

◆ StageCreateTable()

◆ TableExists()

◆ UpdateNamespaceProperties()

◆ UpdateTable()