Package org.apache.iceberg.rest

Class CatalogHandlers

java.lang.Object

org.apache.iceberg.rest.CatalogHandlers

public class CatalogHandlers
extends Object

Method Summary

Modifier and Type	Method	Description
static void	cancelPlanTableScan(String planId)	Cancels a plan table scan by removing all associated state.
static CreateNamespaceResponse	createNamespace(SupportsNamespaces catalog, CreateNamespaceRequest request)
static LoadTableResponse	createTable(Catalog catalog, Namespace namespace, CreateTableRequest request)
static LoadViewResponse	createView(ViewCatalog catalog, Namespace namespace, CreateViewRequest request)
static void	dropNamespace(SupportsNamespaces catalog, Namespace namespace)
static void	dropTable(Catalog catalog, TableIdentifier ident)
static void	dropView(ViewCatalog catalog, TableIdentifier viewIdentifier)
static FetchPlanningResultResponse	fetchPlanningResult(Catalog catalog, TableIdentifier ident, String planId)	Fetches the planning result for an async plan.
static FetchScanTasksResponse	fetchScanTasks(Catalog catalog, TableIdentifier ident, FetchScanTasksRequest request)	Fetches scan tasks for a specific plan task.
static ListNamespacesResponse	listNamespaces(SupportsNamespaces catalog, Namespace parent)
static ListNamespacesResponse	listNamespaces(SupportsNamespaces catalog, Namespace parent, String pageToken, String pageSize)
static ListTablesResponse	listTables(Catalog catalog, Namespace namespace)
static ListTablesResponse	listTables(Catalog catalog, Namespace namespace, String pageToken, String pageSize)
static ListTablesResponse	listViews(ViewCatalog catalog, Namespace namespace)
static ListTablesResponse	listViews(ViewCatalog catalog, Namespace namespace, String pageToken, String pageSize)
static GetNamespaceResponse	loadNamespace(SupportsNamespaces catalog, Namespace namespace)
static LoadTableResponse	loadTable(Catalog catalog, TableIdentifier ident)	Deprecated. since 1.11.0, will be removed in 1.12.0.
static LoadTableResponse	loadTable(Catalog catalog, TableIdentifier ident, RESTCatalogProperties.SnapshotMode mode)
static LoadViewResponse	loadView(ViewCatalog catalog, TableIdentifier viewIdentifier)
static void	namespaceExists(SupportsNamespaces catalog, Namespace namespace)
static PlanTableScanResponse	planTableScan(Catalog catalog, TableIdentifier ident, PlanTableScanRequest request, Predicate<Scan<?,FileScanTask,?>> shouldPlanAsync, ToIntFunction<Scan<?,FileScanTask,?>> tasksPerPlanTask)
static void	purgeTable(Catalog catalog, TableIdentifier ident)
static LoadTableResponse	registerTable(Catalog catalog, Namespace namespace, RegisterTableRequest request)
static LoadViewResponse	registerView(ViewCatalog catalog, Namespace namespace, RegisterViewRequest request)
static void	renameTable(Catalog catalog, RenameTableRequest request)
static void	renameView(ViewCatalog catalog, RenameTableRequest request)
static LoadTableResponse	stageTableCreate(Catalog catalog, Namespace namespace, CreateTableRequest request)
static void	tableExists(Catalog catalog, TableIdentifier ident)
static UpdateNamespacePropertiesResponse	updateNamespaceProperties(SupportsNamespaces catalog, Namespace namespace, UpdateNamespacePropertiesRequest request)
static LoadTableResponse	updateTable(Catalog catalog, TableIdentifier ident, UpdateTableRequest request)
static LoadViewResponse	updateView(ViewCatalog catalog, TableIdentifier ident, UpdateTableRequest request)
static void	viewExists(ViewCatalog catalog, TableIdentifier viewIdentifier)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

listNamespaces

public static ListNamespacesResponse listNamespaces(SupportsNamespaces catalog,
 Namespace parent)

listNamespaces

public static ListNamespacesResponse listNamespaces(SupportsNamespaces catalog,
 Namespace parent,
 String pageToken,
 String pageSize)

createNamespace

public static CreateNamespaceResponse createNamespace(SupportsNamespaces catalog,
 CreateNamespaceRequest request)

namespaceExists

public static void namespaceExists(SupportsNamespaces catalog,
 Namespace namespace)

loadNamespace

public static GetNamespaceResponse loadNamespace(SupportsNamespaces catalog,
 Namespace namespace)

dropNamespace

public static void dropNamespace(SupportsNamespaces catalog,
 Namespace namespace)

updateNamespaceProperties

public static UpdateNamespacePropertiesResponse updateNamespaceProperties(SupportsNamespaces catalog,
 Namespace namespace,
 UpdateNamespacePropertiesRequest request)

listTables

public static ListTablesResponse listTables(Catalog catalog,
 Namespace namespace)

listTables

public static ListTablesResponse listTables(Catalog catalog,
 Namespace namespace,
 String pageToken,
 String pageSize)

stageTableCreate

public static LoadTableResponse stageTableCreate(Catalog catalog,
 Namespace namespace,
 CreateTableRequest request)

createTable

public static LoadTableResponse createTable(Catalog catalog,
 Namespace namespace,
 CreateTableRequest request)

registerTable

public static LoadTableResponse registerTable(Catalog catalog,
 Namespace namespace,
 RegisterTableRequest request)

dropTable

public static void dropTable(Catalog catalog,
 TableIdentifier ident)

purgeTable

public static void purgeTable(Catalog catalog,
 TableIdentifier ident)

tableExists

public static void tableExists(Catalog catalog,
 TableIdentifier ident)

loadTable

@Deprecated
public static LoadTableResponse loadTable(Catalog catalog,
 TableIdentifier ident)

Deprecated.

since 1.11.0, will be removed in 1.12.0. Use loadTable(Catalog, TableIdentifier, SnapshotMode) instead.

loadTable

public static LoadTableResponse loadTable(Catalog catalog,
 TableIdentifier ident,
 RESTCatalogProperties.SnapshotMode mode)

updateTable

public static LoadTableResponse updateTable(Catalog catalog,
 TableIdentifier ident,
 UpdateTableRequest request)

renameTable

public static void renameTable(Catalog catalog,
 RenameTableRequest request)

listViews

public static ListTablesResponse listViews(ViewCatalog catalog,
 Namespace namespace)

listViews

public static ListTablesResponse listViews(ViewCatalog catalog,
 Namespace namespace,
 String pageToken,
 String pageSize)

createView

public static LoadViewResponse createView(ViewCatalog catalog,
 Namespace namespace,
 CreateViewRequest request)

viewExists

public static void viewExists(ViewCatalog catalog,
 TableIdentifier viewIdentifier)

loadView

public static LoadViewResponse loadView(ViewCatalog catalog,
 TableIdentifier viewIdentifier)

updateView

public static LoadViewResponse updateView(ViewCatalog catalog,
 TableIdentifier ident,
 UpdateTableRequest request)

renameView

public static void renameView(ViewCatalog catalog,
 RenameTableRequest request)

dropView

public static void dropView(ViewCatalog catalog,
 TableIdentifier viewIdentifier)

registerView

public static LoadViewResponse registerView(ViewCatalog catalog,
 Namespace namespace,
 RegisterViewRequest request)

planTableScan

public static PlanTableScanResponse planTableScan(Catalog catalog,
 TableIdentifier ident,
 PlanTableScanRequest request,
 Predicate<Scan<?,FileScanTask,?>> shouldPlanAsync,
 ToIntFunction<Scan<?,FileScanTask,?>> tasksPerPlanTask)

fetchPlanningResult

public static FetchPlanningResultResponse fetchPlanningResult(Catalog catalog,
 TableIdentifier ident,
 String planId)

Fetches the planning result for an async plan.

Parameters:

catalog - the catalog to use for loading the table

ident - the table identifier

planId - the plan identifier

Returns:

the fetch planning result response

fetchScanTasks

public static FetchScanTasksResponse fetchScanTasks(Catalog catalog,
 TableIdentifier ident,
 FetchScanTasksRequest request)

Fetches scan tasks for a specific plan task.

Parameters:

catalog - the catalog to use for loading the table

ident - the table identifier

request - the fetch scan tasks request

Returns:

the fetch scan tasks response

cancelPlanTableScan

public static void cancelPlanTableScan(String planId)

Cancels a plan table scan by removing all associated state.

Parameters:

planId - the plan identifier to cancel