io.debezium.relational

Interface ColumnEditor

All Superinterfaces:

Comparable<Column>

All Known Implementing Classes:

ColumnEditorImpl

@NotThreadSafe
public interface ColumnEditor
extends Comparable<Column>

An editor for Column instances.

Author:

Randall Hauch

Method Summary

Modifier and Type	Method and Description
ColumnEditor	autoIncremented(boolean autoIncremented) Set whether the column's values are automatically incremented.
Column	create() Obtain an immutable column definition representing the current state of this editor.
ColumnEditor	generated(boolean generated) Set whether the column's values are generated by the database.
boolean	isAutoIncremented() Determine whether this column's values are automatically incremented by the database.
boolean	isGenerated() Determine whether this column's values are generated by the database.
boolean	isOptional() Determine whether this column is optional.
int	jdbcType() Get the JDBC type for this column
ColumnEditor	jdbcType(int jdbcType) Set the JDBC type of this column.
int	length() Get the maximum length of this column's values.
ColumnEditor	length(int length) Set the maximum length of this column's values.
String	name() Get the name of the column.
ColumnEditor	name(String name) Set the name of the column.
ColumnEditor	optional(boolean optional) Set whether the column's values are optional (e.g., can contain nulls).
int	position() Get the position of the column in the table.
ColumnEditor	position(int position) Set the position of the column within the table definition.
int	scale() Get the scale of the column.
ColumnEditor	scale(int scale) Set the scale of the column.
String	typeName() Get the database-specific name of the column's data type.
ColumnEditor	typeName(String typeName) Set the database-specific name of the column's data type.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

name

String name()

Get the name of the column.

Returns:

the column name; may be null if not set

position

int position()

Get the position of the column in the table.

Returns:

the 1-based position

jdbcType

int jdbcType()

Get the JDBC type for this column

Returns:

the type constant

typeName

String typeName()

Get the database-specific name of the column's data type.

Returns:

the name of the type; may be null if not set

length

int length()

Get the maximum length of this column's values. For numeric columns, this represents the precision.

Returns:

the length of the column

scale

int scale()

Get the scale of the column.

Returns:

the scale, or -1 if the scale does not apply to this type

isOptional

boolean isOptional()

Determine whether this column is optional.

Returns:

true if it is optional, or false otherwise

isAutoIncremented

boolean isAutoIncremented()

Determine whether this column's values are automatically incremented by the database.

Returns:

true if the values are auto-incremented, or false otherwise

isGenerated

boolean isGenerated()

Determine whether this column's values are generated by the database.

Returns:

true if the values are generated, or false otherwise

name

ColumnEditor name(String name)

Set the name of the column.

Parameters:

name - the column name

Returns:

this editor so callers can chain methods together

typeName

ColumnEditor typeName(String typeName)

Set the database-specific name of the column's data type.

Parameters:

typeName - the column's type name

Returns:

this editor so callers can chain methods together

jdbcType

ColumnEditor jdbcType(int jdbcType)

Set the JDBC type of this column.

Parameters:

jdbcType - JDBC type for this column

Returns:

this editor so callers can chain methods together

length

ColumnEditor length(int length)

Set the maximum length of this column's values. For numeric columns, this represents the precision.

Parameters:

length - the column's length

Returns:

this editor so callers can chain methods together

scale

ColumnEditor scale(int scale)

Set the scale of the column.

Parameters:

scale - the scale, or -1 if the scale does not apply to this type

Returns:

this editor so callers can chain methods together

optional

ColumnEditor optional(boolean optional)

Set whether the column's values are optional (e.g., can contain nulls).

Parameters:

optional - true if the column's values are optional, or false otherwise

Returns:

this editor so callers can chain methods together

autoIncremented

ColumnEditor autoIncremented(boolean autoIncremented)

Set whether the column's values are automatically incremented.

Parameters:

autoIncremented - true if the column's values are automatically incremented by the database, or false otherwise

Returns:

this editor so callers can chain methods together

generated

ColumnEditor generated(boolean generated)

Set whether the column's values are generated by the database.

Parameters:

generated - true if the column's values are generated by the database, or false otherwise

Returns:

this editor so callers can chain methods together

position

ColumnEditor position(int position)

Set the position of the column within the table definition.

Parameters:

position - the new column position

Returns:

this editor so callers can chain methods together

create

Column create()

Obtain an immutable column definition representing the current state of this editor. Typically, an editor is created and used to build a column, and then discarded. However, this editor with its current state can be reused after this method, since the resulting column definition no longer refers to any of the data used in this editor.

Returns:

the immutable column definition; never null