package catalog

Import Path
	github.com/polarsignals/iceberg-go/catalog (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	    bucket.go
	    catalog.go
	    hdfs.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Catalog (interface)
		Catalog for iceberg table operations like create, drop, load, list and others.

		Methods (total 11)
			( Catalog) CatalogType() CatalogType
				CatalogType returns the type of the catalog.

			( Catalog) CreateNamespace(ctx context.Context, namespace table.Identifier, props iceberg.Properties) error
				CreateNamespace tells the catalog to create a new namespace with the given properties

			( Catalog) CreateTable(ctx context.Context, location string, schema *iceberg.Schema, props iceberg.Properties, options ...TableOption) (table.Table, error)
				CreateTable tells the catalog to create a new table with the given schema and properties

			( Catalog) DropNamespace(ctx context.Context, namespace table.Identifier) error
				DropNamespace tells the catalog to drop the namespace and all tables in that namespace

			( Catalog) DropTable(ctx context.Context, identifier table.Identifier) error
				DropTable tells the catalog to drop the table entirely

			( Catalog) ListNamespaces(ctx context.Context, parent table.Identifier) ([]table.Identifier, error)
				ListNamespaces returns the list of available namespaces, optionally filtering by a
				parent namespace

			( Catalog) ListTables(ctx context.Context, namespace table.Identifier) ([]table.Identifier, error)
				ListTables returns a list of table identifiers in the catalog, with the returned
				identifiers containing the information required to load the table via that catalog.

			( Catalog) LoadNamespaceProperties(ctx context.Context, namespace table.Identifier) (iceberg.Properties, error)
				LoadNamespaceProperties returns the current properties in the catalog for
				a given namespace

			( Catalog) LoadTable(ctx context.Context, identifier table.Identifier, props iceberg.Properties) (table.Table, error)
				LoadTable loads a table from the catalog and returns a Table with the metadata.

			( Catalog) RenameTable(ctx context.Context, from, to table.Identifier) (table.Table, error)
				RenameTable tells the catalog to rename a given table by the identifiers
				provided, and then loads and returns the destination table

			( Catalog) UpdateNamespaceProperties(ctx context.Context, namespace table.Identifier, removals []string, updates iceberg.Properties) (PropertiesUpdateSummary, error)
				UpdateNamespaceProperties allows removing, adding, and/or updating properties of a namespace

		As Outputs Of (at least one exported)
			func NewHDFS(uri string, bucket objstore.Bucket) Catalog
		As Inputs Of (at least one exported)
			func github.com/polarsignals/frostdb/storage.NewIceberg(uri string, ctlg Catalog, bucket objstore.Bucket, options ...storage.IcebergOption) (*storage.Iceberg, error)

	 type CatalogType string (basic type)

		As Outputs Of (at least one exported)
			func Catalog.CatalogType() CatalogType
		As Types Of (total 6)
			const DynamoDB
			const Glue
			const Hadoop
			const Hive
			const REST
			const SQL

	 type PropertiesUpdateSummary (struct)

		Fields (total 3)
			Missing []string
			Removed []string
			Updated []string
		As Outputs Of (at least one exported)
			func Catalog.UpdateNamespaceProperties(ctx context.Context, namespace table.Identifier, removals []string, updates iceberg.Properties) (PropertiesUpdateSummary, error)

	 type TableOption (func)

		As Outputs Of (at least one exported)
			func WithPartitionSpec(spec iceberg.PartitionSpec) TableOption
		As Inputs Of (at least one exported)
			func Catalog.CreateTable(ctx context.Context, location string, schema *iceberg.Schema, props iceberg.Properties, options ...TableOption) (table.Table, error)


Package-Level Functions (total 5)

	 func NamespaceFromIdent(ident table.Identifier) table.Identifier
	 func NewHDFS(uri string, bucket objstore.Bucket) Catalog
	 func NewIcebucket(warehouseURI string, bucket objstore.Bucket) *icebucket
		NewIcebucket creates a new icebucket with the given prefix and bucket.
		The warehouseURI is used to strip the full path of the data warehouse from the object name.

	 func TableNameFromIdent(ident table.Identifier) string
	 func WithPartitionSpec(spec iceberg.PartitionSpec) TableOption
Package-Level Variables (total 4)

	  var ErrNamespaceAlreadyExists error
	  var ErrNoSuchNamespace error
	  var ErrNoSuchTable error
		ErrNoSuchTable is returned when a table does not exist in the catalog.

	  var ErrorTableNotFound error
Package-Level Constants (total 6)

	const DynamoDB CatalogType = "dynamodb"
	const Glue CatalogType = "glue"
	const Hadoop CatalogType = "hadoop"
	const Hive CatalogType = "hive"
	const REST CatalogType = "rest"
	const SQL CatalogType = "sql"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.