Record Class SqlTableMapping

java.lang.Object

java.lang.Record

io.micronaut.data.model.schema.sql.SqlTableMapping

Record Components:

schema - The schema name, not required

name - The table name

escape - An indicator telling whether table and column names require escaping

type - The table mapping type

primaryKeyColumns - The list of primary key columns, can be null or empty

columns - The list of columns. See SqlColumnMapping

sequences - The list of table sequences, can be null or empty. See SqlSequenceMapping

indexes - The list of table indexes, can be null or empty. See SqlIndexMapping

@Internal
public record SqlTableMapping(@Nullable String schema, String name, boolean escape, SqlTableMapping.TableType type, List<SqlColumnMapping> primaryKeyColumns, List<SqlColumnMapping> columns, List<SqlSequenceMapping> sequences, List<SqlIndexMapping> indexes)
extends Record

The SQL table mapping information extracted from the PersistentEntity.

Since:

4.13.0

Author:

radovanradic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SqlTableMapping.TableType	The SQL table mapping table type.

Constructor Summary

Constructors

Constructor	Description
SqlTableMapping(@Nullable String schema, String name, boolean escape, SqlTableMapping.TableType type, List<SqlColumnMapping> primaryKeyColumns, @Nullable List<SqlColumnMapping> columns)
SqlTableMapping(@Nullable String schema, String name, boolean escape, SqlTableMapping.TableType type, List<SqlColumnMapping> primaryKeyColumns, @Nullable List<SqlColumnMapping> columns, @Nullable List<SqlSequenceMapping> sequences)
SqlTableMapping(@Nullable String schema, String name, boolean escape, SqlTableMapping.TableType type, List<SqlColumnMapping> primaryKeyColumns, List<SqlColumnMapping> columns, List<SqlSequenceMapping> sequences, List<SqlIndexMapping> indexes)	Creates an instance of a SqlTableMapping record class.

Method Summary

Modifier and Type	Method	Description
List<SqlColumnMapping>	columns()	Returns the value of the columns record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	escape()	Returns the value of the escape record component.
final int	hashCode()	Returns a hash code value for this object.
List<SqlIndexMapping>	indexes()	Returns the value of the indexes record component.
String	name()	Returns the value of the name record component.
List<SqlColumnMapping>	primaryKeyColumns()	Returns the value of the primaryKeyColumns record component.
@Nullable String	schema()	Returns the value of the schema record component.
List<SqlSequenceMapping>	sequences()	Returns the value of the sequences record component.
final String	toString()	Returns a string representation of this record class.
SqlTableMapping.TableType	type()	Returns the value of the type record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SqlTableMapping

public SqlTableMapping(@Nullable String schema,
 String name,
 boolean escape,
 SqlTableMapping.TableType type,
 List<SqlColumnMapping> primaryKeyColumns,
 @Nullable List<SqlColumnMapping> columns)

SqlTableMapping

public SqlTableMapping(@Nullable String schema,
 String name,
 boolean escape,
 SqlTableMapping.TableType type,
 List<SqlColumnMapping> primaryKeyColumns,
 @Nullable List<SqlColumnMapping> columns,
 @Nullable List<SqlSequenceMapping> sequences)

SqlTableMapping

public SqlTableMapping(@Nullable String schema,
 String name,
 boolean escape,
 SqlTableMapping.TableType type,
 List<SqlColumnMapping> primaryKeyColumns,
 List<SqlColumnMapping> columns,
 List<SqlSequenceMapping> sequences,
 List<SqlIndexMapping> indexes)

Creates an instance of a SqlTableMapping record class.

Parameters:

schema - the value for the schema record component

name - the value for the name record component

escape - the value for the escape record component

type - the value for the type record component

primaryKeyColumns - the value for the primaryKeyColumns record component

columns - the value for the columns record component

sequences - the value for the sequences record component

indexes - the value for the indexes record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schema

public @Nullable String schema()

Returns the value of the schema record component.

Returns:

the value of the schema record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

escape

public boolean escape()

Returns the value of the escape record component.

Returns:

the value of the escape record component

type

public SqlTableMapping.TableType type()

Returns the value of the type record component.

Returns:

the value of the type record component

primaryKeyColumns

public List<SqlColumnMapping> primaryKeyColumns()

Returns the value of the primaryKeyColumns record component.

Returns:

the value of the primaryKeyColumns record component

columns

public List<SqlColumnMapping> columns()

Returns the value of the columns record component.

Returns:

the value of the columns record component

sequences

public List<SqlSequenceMapping> sequences()

Returns the value of the sequences record component.

Returns:

the value of the sequences record component

indexes

public List<SqlIndexMapping> indexes()

Returns the value of the indexes record component.

Returns:

the value of the indexes record component