モジュール org.nkjmlab.sorm4j

パッケージ org.nkjmlab.sorm4j.util.table_def

クラス TableDefinition

java.lang.Object

org.nkjmlab.sorm4j.util.table_def.TableDefinition

public final class TableDefinition
extends Object

This class represent a table schema. This class is a utility for users to define tables and indexes. It should be noted that there is no guarantee that this object will match the table definition in the database.

作成者:

nkjm

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラス	説明
static class	TableDefinition.Builder

メソッドの概要

修飾子とタイプ	メソッド	説明
static TableDefinition.Builder	builder(Class<?> ormRecordClass)
static TableDefinition.Builder	builder(String tableName)	Creates a new TableDefinition.Builder with the given table name.
TableDefinition	createIndexesIfNotExists(Orm orm)
TableDefinition	createTableIfNotExists(Orm orm)
TableDefinition	dropTableIfExists(Orm orm)
List<String>	getColumnNames()
List<String>	getCreateIndexIfNotExistsStatements()	Gets create index if not exists statements.
String	getCreateTableIfNotExistsStatement()	Returns a String object representing this TableDefinition's value.
String	getDropTableIfExistsStatement()	Gets drop table if exists statement.
String	getTableName()
String	getTableNameAndColumnDefinitions()	Returns a String object representing this TableDefinition's value.
static String	toSqlDataType(Class<?> type)
String	toString()
static String	toUpperSnakeCase(String compoundName)	Given a field or class name in the form CompoundName (for classes) or compoundName (for fields) will return a set of guessed names such as [COMPOUND_NAME].

クラスから継承されたメソッド java.lang.Object

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

メソッドの詳細

builder

public static TableDefinition.Builder builder(String tableName)

Creates a new TableDefinition.Builder with the given table name.

戻り値:

builder

public static TableDefinition.Builder builder(Class<?> ormRecordClass)

toUpperSnakeCase

public static String toUpperSnakeCase(String compoundName)

Given a field or class name in the form CompoundName (for classes) or compoundName (for fields) will return a set of guessed names such as [COMPOUND_NAME].

toString

public String toString()

オーバーライド:

toString クラス内 Object

createIndexesIfNotExists

public TableDefinition createIndexesIfNotExists(Orm orm)

createTableIfNotExists

public TableDefinition createTableIfNotExists(Orm orm)

dropTableIfExists

public TableDefinition dropTableIfExists(Orm orm)

getColumnNames

public List<String> getColumnNames()

getCreateIndexIfNotExistsStatements

public List<String> getCreateIndexIfNotExistsStatements()

Gets create index if not exists statements. Example.

 TableDefinition.builder("reports") .addColumnDefinition("id", VARCHAR,
 PRIMARY_KEY).addColumnDefinition("score", INT)
 .addIndexDefinition("score").addIndexDefinition("id",
 "score").build().getCreateIndexIfNotExistsStatements();

 generates

 "[create index if not exists index_reports_score on reports(score), create index if not exists
 index_reports_id_score on reports(id, score)]"

戻り値:

getCreateTableIfNotExistsStatement

public String getCreateTableIfNotExistsStatement()

Returns a String object representing this TableDefinition's value.

 TableDefinition.builder("reports").addColumnDefinition("id", VARCHAR, PRIMARY_KEY)
 .addColumnDefinition("score", INT).build().getTableSchema();

 generates

 "create table if not exists reports(id varchar primary key, score int)"

戻り値:

getDropTableIfExistsStatement

public String getDropTableIfExistsStatement()

Gets drop table if exists statement.

戻り値:

getTableName

public String getTableName()

getTableNameAndColumnDefinitions

public String getTableNameAndColumnDefinitions()

Returns a String object representing this TableDefinition's value.

 TableDefinition.builder("reports").addColumnDefinition("id", VARCHAR, PRIMARY_KEY)
 .addColumnDefinition("score", INT).build().getTableSchema();

 generates

 "reports(id varchar primary key, score int)"

戻り値:

toSqlDataType

public static String toSqlDataType(Class<?> type)