org.apache.paimon.privilege

Class PrivilegedCatalog

java.lang.Object

org.apache.paimon.catalog.DelegateCatalog

org.apache.paimon.privilege.PrivilegedCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

public class PrivilegedCatalog
extends DelegateCatalog

Catalog which supports privilege system.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.catalog.Catalog

Catalog.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNoPermissionException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNoPermissionException, Catalog.TableNotExistException, Catalog.ViewAlreadyExistException, Catalog.ViewNotExistException

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigOption<String>	PASSWORD
static ConfigOption<String>	USER

Fields inherited from class org.apache.paimon.catalog.DelegateCatalog

wrapped

Fields inherited from interface org.apache.paimon.catalog.Catalog

COMMENT_PROP, DB_LOCATION_PROP, DB_SUFFIX, DEFAULT_DATABASE, LAST_UPDATE_TIME_PROP, NUM_FILES_PROP, NUM_ROWS_PROP, OWNER_PROP, SYSTEM_BRANCH_PREFIX, SYSTEM_DATABASE_NAME, SYSTEM_TABLE_SPLITTER, TABLE_DEFAULT_OPTION_PREFIX, TOTAL_SIZE_PROP

Constructor Summary

Constructors

Constructor and Description
PrivilegedCatalog(Catalog wrapped, PrivilegeManagerLoader privilegeManagerLoader)

Method Summary

Modifier and Type	Method and Description
void	alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists) Alter a database.
void	alterPartitions(Identifier identifier, List<Partition> partitions) Alter partitions of the specify table.
void	alterTable(Identifier identifier, List<SchemaChange> changes, boolean ignoreIfNotExists) Modify an existing table from SchemaChanges.
CatalogLoader	catalogLoader() Serializable loader to create catalog.
void	createDatabase(String name, boolean ignoreIfExists, Map<String,String> properties) Create a database with properties.
void	createPartitions(Identifier identifier, List<Map<String,String>> partitions) Create partitions of the specify table.
void	createPrivilegedUser(String user, String password)
void	createTable(Identifier identifier, Schema schema, boolean ignoreIfExists) Create a new table.
void	dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade) Drop a database.
void	dropPartitions(Identifier identifier, List<Map<String,String>> partitions) Drop partitions of the specify table.
void	dropPrivilegedUser(String user)
void	dropTable(Identifier identifier, boolean ignoreIfNotExists) Drop a table.
Table	getTable(Identifier identifier) Return a Table identified by the given Identifier.
void	grantPrivilegeOnCatalog(String user, PrivilegeType privilege)
void	grantPrivilegeOnDatabase(String user, String databaseName, PrivilegeType privilege)
void	grantPrivilegeOnTable(String user, Identifier identifier, PrivilegeType privilege)
void	markDonePartitions(Identifier identifier, List<Map<String,String>> partitions) Mark partitions done of the specify table.
PrivilegeManager	privilegeManager()
void	renameTable(Identifier fromTable, Identifier toTable, boolean ignoreIfNotExists) Rename a table.
int	revokePrivilegeOnCatalog(String user, PrivilegeType privilege) Returns the number of privilege revoked.
int	revokePrivilegeOnDatabase(String user, String databaseName, PrivilegeType privilege) Returns the number of privilege revoked.
int	revokePrivilegeOnTable(String user, Identifier identifier, PrivilegeType privilege) Returns the number of privilege revoked.
static Catalog	tryToCreate(Catalog catalog, Options options)

Methods inherited from class org.apache.paimon.catalog.DelegateCatalog

caseSensitive, close, createView, dropView, getDatabase, getView, listDatabases, listPartitions, listTables, listViews, options, renameView, repairCatalog, repairDatabase, repairTable, rootCatalog, wrapped

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.catalog.Catalog

alterTable, createDatabase, invalidateTable

Field Detail

USER

public static final ConfigOption<String> USER

PASSWORD

public static final ConfigOption<String> PASSWORD

Constructor Detail

PrivilegedCatalog

public PrivilegedCatalog(Catalog wrapped,
                         PrivilegeManagerLoader privilegeManagerLoader)

Method Detail

tryToCreate

public static Catalog tryToCreate(Catalog catalog,
                                  Options options)

privilegeManager

public PrivilegeManager privilegeManager()

catalogLoader

public CatalogLoader catalogLoader()

Description copied from interface: Catalog

Serializable loader to create catalog.

createDatabase

public void createDatabase(String name,
                           boolean ignoreIfExists,
                           Map<String,String> properties)
                    throws Catalog.DatabaseAlreadyExistException

Description copied from interface: Catalog

Create a database with properties.

Specified by:

createDatabase in interface Catalog

Overrides:

createDatabase in class DelegateCatalog

Parameters:

name - Name of the database to be created

ignoreIfExists - Flag to specify behavior when a database with the given name already exists: if set to false, throw a DatabaseAlreadyExistException, if set to true, do nothing.

properties - properties to be associated with the database

Throws:

Catalog.DatabaseAlreadyExistException - if the given database already exists and ignoreIfExists is false

dropDatabase

public void dropDatabase(String name,
                         boolean ignoreIfNotExists,
                         boolean cascade)
                  throws Catalog.DatabaseNotExistException,
                         Catalog.DatabaseNotEmptyException

Description copied from interface: Catalog

Drop a database.

Specified by:

dropDatabase in interface Catalog

Overrides:

dropDatabase in class DelegateCatalog

Parameters:

name - Name of the database to be dropped.

ignoreIfNotExists - Flag to specify behavior when the database does not exist: if set to false, throw an exception, if set to true, do nothing.

cascade - Flag to specify behavior when the database contains table or function: if set to true, delete all tables and functions in the database and then delete the database, if set to false, throw an exception.

Throws:

Catalog.DatabaseNotEmptyException - if the given database is not empty and isRestrict is true

Catalog.DatabaseNotExistException

alterDatabase

public void alterDatabase(String name,
                          List<PropertyChange> changes,
                          boolean ignoreIfNotExists)
                   throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Alter a database.

Specified by:

alterDatabase in interface Catalog

Overrides:

alterDatabase in class DelegateCatalog

Parameters:

name - Name of the database to alter.

changes - the property changes

ignoreIfNotExists - Flag to specify behavior when the database does not exist: if set to false, throw an exception, if set to true, do nothing.

Throws:

Catalog.DatabaseNotExistException - if the given database is not exist and ignoreIfNotExists is false

dropTable

public void dropTable(Identifier identifier,
                      boolean ignoreIfNotExists)
               throws Catalog.TableNotExistException

Description copied from interface: Catalog

Drop a table.

NOTE: System tables can not be dropped.

Specified by:

dropTable in interface Catalog

Overrides:

dropTable in class DelegateCatalog

Parameters:

identifier - Path of the table to be dropped

ignoreIfNotExists - Flag to specify behavior when the table does not exist: if set to false, throw an exception, if set to true, do nothing.

Throws:

Catalog.TableNotExistException - if the table does not exist

createTable

public void createTable(Identifier identifier,
                        Schema schema,
                        boolean ignoreIfExists)
                 throws Catalog.TableAlreadyExistException,
                        Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Create a new table.

NOTE: System tables can not be created.

Specified by:

createTable in interface Catalog

Overrides:

createTable in class DelegateCatalog

Parameters:

identifier - path of the table to be created

schema - the table definition

ignoreIfExists - flag to specify behavior when a table already exists at the given path: if set to false, it throws a TableAlreadyExistException, if set to true, do nothing.

Throws:

Catalog.TableAlreadyExistException - if table already exists and ignoreIfExists is false

Catalog.DatabaseNotExistException - if the database in identifier doesn't exist

renameTable

public void renameTable(Identifier fromTable,
                        Identifier toTable,
                        boolean ignoreIfNotExists)
                 throws Catalog.TableNotExistException,
                        Catalog.TableAlreadyExistException

Description copied from interface: Catalog

Rename a table.

NOTE: If you use object storage, such as S3 or OSS, please use this syntax carefully, because the renaming of object storage is not atomic, and only partial files may be moved in case of failure.

NOTE: System tables can not be renamed.

Specified by:

renameTable in interface Catalog

Overrides:

renameTable in class DelegateCatalog

Parameters:

fromTable - the name of the table which need to rename

toTable - the new table

ignoreIfNotExists - Flag to specify behavior when the table does not exist: if set to false, throw an exception, if set to true, do nothing.

Throws:

Catalog.TableNotExistException - if the fromTable does not exist

Catalog.TableAlreadyExistException - if the toTable already exists

alterTable

public void alterTable(Identifier identifier,
                       List<SchemaChange> changes,
                       boolean ignoreIfNotExists)
                throws Catalog.TableNotExistException,
                       Catalog.ColumnAlreadyExistException,
                       Catalog.ColumnNotExistException

Description copied from interface: Catalog

Modify an existing table from SchemaChanges.

NOTE: System tables can not be altered.

Specified by:

alterTable in interface Catalog

Overrides:

alterTable in class DelegateCatalog

Parameters:

identifier - path of the table to be modified

changes - the schema changes

ignoreIfNotExists - flag to specify behavior when the table does not exist: if set to false, throw an exception, if set to true, do nothing.

Throws:

Catalog.TableNotExistException - if the table does not exist

Catalog.ColumnAlreadyExistException

Catalog.ColumnNotExistException

getTable

public Table getTable(Identifier identifier)
               throws Catalog.TableNotExistException

Description copied from interface: Catalog

Return a Table identified by the given Identifier.

System tables can be got by '$' splitter.

Specified by:

getTable in interface Catalog

Overrides:

getTable in class DelegateCatalog

Parameters:

identifier - Path of the table

Returns:

The requested table

Throws:

Catalog.TableNotExistException - if the target does not exist

createPartitions

public void createPartitions(Identifier identifier,
                             List<Map<String,String>> partitions)
                      throws Catalog.TableNotExistException

Description copied from interface: Catalog

Create partitions of the specify table.

Only catalog with metastore can support this method, and only table with 'metastore.partitioned-table' can support this method.

Specified by:

createPartitions in interface Catalog

Overrides:

createPartitions in class DelegateCatalog

Parameters:

identifier - path of the table to create partitions

partitions - partitions to be created

Throws:

Catalog.TableNotExistException - if the table does not exist

dropPartitions

public void dropPartitions(Identifier identifier,
                           List<Map<String,String>> partitions)
                    throws Catalog.TableNotExistException

Description copied from interface: Catalog

Drop partitions of the specify table.

Specified by:

dropPartitions in interface Catalog

Overrides:

dropPartitions in class DelegateCatalog

Parameters:

identifier - path of the table to drop partitions

partitions - partitions to be deleted

Throws:

Catalog.TableNotExistException - if the table does not exist

alterPartitions

public void alterPartitions(Identifier identifier,
                            List<Partition> partitions)
                     throws Catalog.TableNotExistException

Description copied from interface: Catalog

Alter partitions of the specify table.

Only catalog with metastore can support this method, and only table with 'metastore.partitioned-table' can support this method.

Specified by:

alterPartitions in interface Catalog

Overrides:

alterPartitions in class DelegateCatalog

Parameters:

identifier - path of the table to alter partitions

partitions - partitions to be altered

Throws:

Catalog.TableNotExistException - if the table does not exist

markDonePartitions

public void markDonePartitions(Identifier identifier,
                               List<Map<String,String>> partitions)
                        throws Catalog.TableNotExistException

Description copied from interface: Catalog

Mark partitions done of the specify table.

Only catalog with metastore can support this method, and only table with 'metastore.partitioned-table' can support this method.

Specified by:

markDonePartitions in interface Catalog

Overrides:

markDonePartitions in class DelegateCatalog

Parameters:

identifier - path of the table to mark done partitions

partitions - partitions to be marked done

Throws:

Catalog.TableNotExistException - if the table does not exist

createPrivilegedUser

public void createPrivilegedUser(String user,
                                 String password)

dropPrivilegedUser

public void dropPrivilegedUser(String user)

grantPrivilegeOnCatalog

public void grantPrivilegeOnCatalog(String user,
                                    PrivilegeType privilege)

grantPrivilegeOnDatabase

public void grantPrivilegeOnDatabase(String user,
                                     String databaseName,
                                     PrivilegeType privilege)

grantPrivilegeOnTable

public void grantPrivilegeOnTable(String user,
                                  Identifier identifier,
                                  PrivilegeType privilege)

revokePrivilegeOnCatalog

public int revokePrivilegeOnCatalog(String user,
                                    PrivilegeType privilege)

Returns the number of privilege revoked.

revokePrivilegeOnDatabase

public int revokePrivilegeOnDatabase(String user,
                                     String databaseName,
                                     PrivilegeType privilege)

Returns the number of privilege revoked.

revokePrivilegeOnTable

public int revokePrivilegeOnTable(String user,
                                  Identifier identifier,
                                  PrivilegeType privilege)

Returns the number of privilege revoked.