org.apache.paimon.schema

Class SchemaManager

java.lang.Object

org.apache.paimon.schema.SchemaManager

All Implemented Interfaces:

Serializable

@ThreadSafe
public class SchemaManager
extends Object
implements Serializable

Schema Manager to manage schema versions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaManager(FileIO fileIO, Path tableRoot)
SchemaManager(FileIO fileIO, Path tableRoot, String branch) Specify the default branch for data writing.

Method Summary

Modifier and Type	Method and Description
void	applyMove(List<DataField> newFields, SchemaChange.Move move)
static void	checkAlterTableOption(String key, String oldValue, String newValue, boolean fromDynamicOptions)
static void	checkAlterTablePath(String key)
static void	checkResetTableOption(String key)
boolean	commit(TableSchema newSchema)
TableSchema	commitChanges(List<SchemaChange> changes) Update SchemaChanges.
TableSchema	commitChanges(SchemaChange... changes) Update SchemaChanges.
SchemaManager	copyWithBranch(String branchName)
TableSchema	createTable(Schema schema)
TableSchema	createTable(Schema schema, boolean externalTable)
void	deleteSchema(long schemaId) Delete schema with specific id.
long	earliestCreationTime()
TableSchema	generateTableSchema(TableSchema oldTableSchema, List<SchemaChange> changes, LazyField<Boolean> hasSnapshots)
static Identifier	identifierFromPath(String tablePath, boolean ignoreIfUnknownDatabase)
static Identifier	identifierFromPath(String tablePath, boolean ignoreIfUnknownDatabase, String branchName)
Optional<TableSchema>	latest()
List<TableSchema>	listAll()
List<Long>	listAllIds() List all schema IDs.
List<TableSchema>	listWithRange(Optional<Long> optionalMaxSchemaId, Optional<Long> optionalMinSchemaId)
boolean	mergeSchema(RowType rowType, boolean allowExplicitCast)
TableSchema	schema(long id) Read schema for schema id.
Path	schemaDirectory()
boolean	schemaExists(long id) Check if a schema exists.
List<Path>	schemaPaths(java.util.function.Predicate<Long> predicate)
List<TableSchema>	schemasWithId(List<Long> schemaIds)
Path	toSchemaPath(long schemaId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaManager

public SchemaManager(FileIO fileIO,
                     Path tableRoot)

SchemaManager

public SchemaManager(FileIO fileIO,
                     Path tableRoot,
                     String branch)

Specify the default branch for data writing.

Method Detail

copyWithBranch

public SchemaManager copyWithBranch(String branchName)

latest

public Optional<TableSchema> latest()

earliestCreationTime

public long earliestCreationTime()

listAll

public List<TableSchema> listAll()

schemasWithId

public List<TableSchema> schemasWithId(List<Long> schemaIds)

listWithRange

public List<TableSchema> listWithRange(Optional<Long> optionalMaxSchemaId,
                                       Optional<Long> optionalMinSchemaId)

listAllIds

public List<Long> listAllIds()

List all schema IDs.

createTable

public TableSchema createTable(Schema schema)
                        throws Exception

Throws:

Exception

createTable

public TableSchema createTable(Schema schema,
                               boolean externalTable)
                        throws Exception

Throws:

Exception

commitChanges

public TableSchema commitChanges(SchemaChange... changes)
                          throws Exception

Update SchemaChanges.

Throws:

Exception

commitChanges

public TableSchema commitChanges(List<SchemaChange> changes)
                          throws Catalog.TableNotExistException,
                                 Catalog.ColumnAlreadyExistException,
                                 Catalog.ColumnNotExistException

Update SchemaChanges.

Throws:

Catalog.TableNotExistException

Catalog.ColumnAlreadyExistException

Catalog.ColumnNotExistException

generateTableSchema

public TableSchema generateTableSchema(TableSchema oldTableSchema,
                                       List<SchemaChange> changes,
                                       LazyField<Boolean> hasSnapshots)
                                throws Catalog.ColumnAlreadyExistException,
                                       Catalog.ColumnNotExistException

Throws:

Catalog.ColumnAlreadyExistException

Catalog.ColumnNotExistException

applyMove

public void applyMove(List<DataField> newFields,
                      SchemaChange.Move move)

mergeSchema

public boolean mergeSchema(RowType rowType,
                           boolean allowExplicitCast)

commit

@VisibleForTesting
public boolean commit(TableSchema newSchema)
                                  throws Exception

Throws:

Exception

schema

public TableSchema schema(long id)

Read schema for schema id.

schemaExists

public boolean schemaExists(long id)

Check if a schema exists.

schemaDirectory

public Path schemaDirectory()

toSchemaPath

@VisibleForTesting
public Path toSchemaPath(long schemaId)

schemaPaths

public List<Path> schemaPaths(java.util.function.Predicate<Long> predicate)
                       throws IOException

Throws:

IOException

deleteSchema

public void deleteSchema(long schemaId)

Delete schema with specific id.

Parameters:

schemaId - the schema id to delete.

checkAlterTableOption

public static void checkAlterTableOption(String key,
                                         @Nullable
                                         String oldValue,
                                         String newValue,
                                         boolean fromDynamicOptions)

checkResetTableOption

public static void checkResetTableOption(String key)

checkAlterTablePath

public static void checkAlterTablePath(String key)

identifierFromPath

public static Identifier identifierFromPath(String tablePath,
                                            boolean ignoreIfUnknownDatabase)

identifierFromPath

public static Identifier identifierFromPath(String tablePath,
                                            boolean ignoreIfUnknownDatabase,
                                            @Nullable
                                            String branchName)