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

クラス TableSchema

java.lang.Object

org.nkjmlab.sorm4j.util.table.TableSchema

public final class TableSchema
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	TableSchema.Builder

メソッドの概要

修飾子とタイプ	メソッド	説明
static TableSchema.Builder	builder(String tableName)	Creates a new TableSchema.Builder with the given table name.
TableSchema	createIndexesIfNotExists(Orm orm)
TableSchema	createTableIfNotExists(Orm orm)
TableSchema	dropTableIfExists(Orm orm)
List<String>	getColumnNames()
List<String>	getCreateIndexIfNotExistsStatements()	Gets create index if not exists statements.
String	getCreateTableIfNotExistsStatement()	Returns a String object representing this TableSchema's value.
String	getDropTableIfExistsStatement()	Gets drop table if exists statement.
String	getTableName()
String	getTableSchema()	Returns a String object representing this TableSchema's value.

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

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

メソッドの詳細

builder

public static TableSchema.Builder builder(String tableName)

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

戻り値:

createIndexesIfNotExists

public TableSchema createIndexesIfNotExists(Orm orm)

createTableIfNotExists

public TableSchema createTableIfNotExists(Orm orm)

dropTableIfExists

public TableSchema dropTableIfExists(Orm orm)

getColumnNames

public List<String> getColumnNames()

getCreateIndexIfNotExistsStatements

public List<String> getCreateIndexIfNotExistsStatements()

Gets create index if not exists statements. Example.

 TableSchema.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 TableSchema's value.

 TableSchema.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()

getTableSchema

public String getTableSchema()

Returns a String object representing this TableSchema's value.

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

 generates

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

戻り値: