Package io.micronaut.data.model.schema.sql.metadata

Class SqlTableMetadata

java.lang.Object

io.micronaut.data.model.schema.sql.metadata.SqlTableMetadata

@Internal
public final class SqlTableMetadata
extends Object

SQL table metadata extracted from the underlying table in the database.

Constructor Summary

Constructors

Constructor	Description
SqlTableMetadata(String catalog, String schema, String name)	Constructs a new instance of SqlTableMetadata with the specified table name.

Method Summary

Modifier and Type	Method	Description
void	addColumn(SqlColumnMetadata column)	Adds a new column to the table metadata.
@Nullable SqlColumnMetadata	getColumn(String name)	Retrieves the SQL column metadata associated with the specified column name.
String	getName()	Returns the name of the SQL table represented by this metadata object.

Methods inherited from class java.lang.Object

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

Constructor Details

SqlTableMetadata

public SqlTableMetadata(String catalog,
 String schema,
 String name)

Constructs a new instance of SqlTableMetadata with the specified table name.

Parameters:

catalog - the catalog where table belongs, can be null

schema - the schema where table belongs. can be null

name - the name of the SQL table

Method Details

addColumn

public void addColumn(SqlColumnMetadata column)

Adds a new column to the table metadata.

Parameters:

column - the column metadata to add

getName

public String getName()

Returns the name of the SQL table represented by this metadata object.

Returns:

the name of the SQL table

getColumn

@Nullable
public @Nullable SqlColumnMetadata getColumn(String name)

Retrieves the SQL column metadata associated with the specified column name.

Parameters:

name - the name of the column to retrieve

Returns:

the SQL column metadata, or null if no such column exists