org.mmbase.storage.implementation.database
Class Schemes

java.lang.Object
  org.mmbase.storage.implementation.database.Schemes

public final class Schemes

extends java.lang.Object

This class defines the scheme names and defaults used by the default database storage manager classes. Specific storage managers may add their own schemes, or not use schemes at all.

Since:

MMBase-1.7

Version:

$Id: Schemes.java,v 1.11.2.1 2005/07/04 14:17:18 michiel Exp $

Author:

Pierre van Rooden

Field Summary

static java.lang.String	CHANGE_FIELD_SCHEME Name of the scheme for changing a field.
static java.lang.String	CHANGE_FIELD_SCHEME_DEFAULT The default scheme for changing a field.
static java.lang.String	CREATE_COMPOSITE_KEY Name of the scheme for creating a unique composite key.
static java.lang.String	CREATE_COMPOSITE_KEY_DEFAULT The default scheme for creating a composite key.
static java.lang.String	CREATE_CONSTRAINT_SCHEME Name of the scheme for creating (adding) a constraint, such as a key or index.
static java.lang.String	CREATE_CONSTRAINT_SCHEME_DEFAULT The default scheme for creating (adding) a constraint.
static java.lang.String	CREATE_FIELD_SCHEME Name of the scheme for creating (adding) a field.
static java.lang.String	CREATE_FIELD_SCHEME_DEFAULT The default scheme for creating (adding) a field.
static java.lang.String	CREATE_FOREIGN_KEY Name of the scheme for creating a foreign (referential) key.
static java.lang.String	CREATE_FOREIGN_KEY_DEFAULT The default scheme for selecting a node type.
static java.lang.String	CREATE_INDEX Name of the scheme for creating an index.
static java.lang.String	CREATE_INDEX_DEFAULT The default scheme for creating an index
static java.lang.String	CREATE_OBJECT_ROW_TYPE Name of the scheme for creating a row type.
static java.lang.String	CREATE_OBJECT_TABLE Name of the scheme for creating a table.
static java.lang.String	CREATE_OBJECT_TABLE_DEFAULT The default scheme for creating a table.
static java.lang.String	CREATE_PRIMARY_KEY Name of the scheme for creating a primary key.
static java.lang.String	CREATE_PRIMARY_KEY_DEFAULT The default scheme for creating a prinary key.
static java.lang.String	CREATE_ROW_TYPE Name of the scheme for creating a row type.
static java.lang.String	CREATE_SECONDARY_INDEX Name of the scheme for creating a secondary index.
static java.lang.String	CREATE_SECONDARY_INDEX_DEFAULT The default scheme for reating a secondary index.
static java.lang.String	CREATE_SEQUENCE Name of the scheme for creating a sequence or number table The parameters accepted are: {0} the storage manager (StorageManager), or the basename for tables (String) {1} the (suggested) field definition of the primary key field ('number')
static java.lang.String	CREATE_SEQUENCE_DEFAULT The default scheme for creating a sequence table.
static java.lang.String	CREATE_TABLE Name of the scheme for creating a table.
static java.lang.String	CREATE_TABLE_DEFAULT The default scheme for creating a table.
static java.lang.String	CREATE_UNIQUE_KEY Name of the scheme for creating a unique key.
static java.lang.String	CREATE_UNIQUE_KEY_DEFAULT The default scheme for selecting a node type.
static java.lang.String	DELETE_CONSTRAINT_SCHEME Name of the scheme for deleting a constraint, such as a key or index.
static java.lang.String	DELETE_CONSTRAINT_SCHEME_DEFAULT The default scheme for deleting a constraint.
static java.lang.String	DELETE_FIELD_SCHEME Name of the scheme for deleting a field.
static java.lang.String	DELETE_FIELD_SCHEME_DEFAULT The default scheme for deleting a field.
static java.lang.String	DELETE_NODE Name of the scheme for selecting a node type.
static java.lang.String	DELETE_NODE_DEFAULT The default scheme for selecting a node type.
static java.lang.String	DELETE_SECONDARY_INDEX Name of the scheme for dropping a secondary index.
static java.lang.String	DELETE_SECONDARY_INDEX_DEFAULT The default scheme for reating a secondary index.
static java.lang.String	DROP_ROW_TYPE Name of the scheme for dropping a row type.
static java.lang.String	DROP_TABLE Name of the scheme for dropping a table.
static java.lang.String	DROP_TABLE_DEFAULT The default scheme for reading a text field.
static java.lang.String	GET_BINARY_DATA Name of the scheme for reading a binary field from a node.
static java.lang.String	GET_BINARY_DATA_DEFAULT The default scheme for reading a binary field.
static java.lang.String	GET_TABLE_SIZE Name of the scheme for obtaining the size of a (builder) table.
static java.lang.String	GET_TABLE_SIZE_DEFAULT The default scheme for reading a text field.
static java.lang.String	GET_TEXT_DATA Name of the scheme for reading a text field from a node.
static java.lang.String	GET_TEXT_DATA_DEFAULT The default scheme for reading a text field.
static java.lang.String	INIT_SEQUENCE Name of the scheme for initializing a sequence or number table The parameters accepted are: {0} the storage manager (StorageManager), or the basename for tables (String) {1} the (suggested) name of the primary key field ('number') {2} the value to init the sequence to
static java.lang.String	INIT_SEQUENCE_DEFAULT The default scheme for initializing a sequence table.
static java.lang.String	INSERT_NODE Name of the scheme for inserting a node.
static java.lang.String	INSERT_NODE_DEFAULT The default scheme for inserting a node type.
static java.lang.String	READ_SEQUENCE Name of the scheme for retrieving the key from sequence or number table The parameters accepted are: {0} the storage manager (StorageManager), or the basename for tables (String) {1} the (suggested) name of the primary key field ('number') {2} the sequence buffer size (nr of keys that MMBase caches in the storage layer).
static java.lang.String	READ_SEQUENCE_DEFAULT The default scheme for retrieving the key from a sequence table.
static java.lang.String	SELECT_NODE Name of the scheme for selecting a node.
static java.lang.String	SELECT_NODE_DEFAULT The default scheme for selecting a node.
static java.lang.String	SELECT_NODE_TYPE Name of the scheme for selecting a node type.
static java.lang.String	SELECT_NODE_TYPE_DEFAULT The default scheme for selecting a node type.
static java.lang.String	UPDATE_NODE Name of the scheme for updating a node type.
static java.lang.String	UPDATE_NODE_DEFAULT The default scheme for updating a node type.
static java.lang.String	UPDATE_SEQUENCE Name of the scheme for updating a sequence or number table The parameters accepted are: {0} the storage manager (StorageManager), or the basename for tables (String) {1} the (suggested) name of the primary key field ('number') {2} the sequence buffer size (nr of keys that MMBase caches in the storage layer).
static java.lang.String	UPDATE_SEQUENCE_DEFAULT The default scheme for updating a sequence table.

Constructor Summary

Schemes()

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_ROW_TYPE

public static final java.lang.String CREATE_ROW_TYPE

Name of the scheme for creating a row type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the row type for

{2} the field definitions (excluding index definitions)

{3} the builder that this rowtype extends from

This attribute is optional, and there is no default for this scheme. An example (for Informix):

CREATE ROW TYPE {1}_t ({2}) EXTENDS {3}_t

See Also:

Constant Field Values

CREATE_TABLE

public static final java.lang.String CREATE_TABLE

Name of the scheme for creating a table. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the table for

{2} the field definitions (excluding simple index definitions)

{3} the simple index definitions. A comma-seperated list, which is preceded by a comma UNLESS there is a rowtype scheme defined

{4} the field definitions, including simple index definitions

{5} the composite index definitions A comma-seperated list, which is preceded by a comma UNLESS there is a rowtype scheme defined, and no other field definitions.

{6} the builder that this table extends from

You can set up your scheme to create extended tables (i.e. in Postgresql). You also can define indexes or fields seperate (i.e. in HSQL or in a create table after a create row type in Informix) or in one go (as you might do with MySQL).

See Also:

Constant Field Values

CREATE_TABLE_DEFAULT

public static final java.lang.String CREATE_TABLE_DEFAULT

The default scheme for creating a table.

See Also:

Constant Field Values

CREATE_OBJECT_ROW_TYPE

public static final java.lang.String CREATE_OBJECT_ROW_TYPE

Name of the scheme for creating a row type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the row type for

{2} the field definitions (excluding index definitions)

This attribute is optional, and there is no default for this scheme. An example (for Informix):

CREATE ROW TYPE {1}_t ({2})

See Also:

Constant Field Values

CREATE_OBJECT_TABLE

public static final java.lang.String CREATE_OBJECT_TABLE

Name of the scheme for creating a table. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the table for

{2} the field definitions (excluding simple index definitions) A comma-seperated list, which is preceded by a comma UNLESS there is a rowtype scheme defined

{3} the simple index definitions

{4} the field definitions, including simple index definitions A comma-seperated list, which is preceded by a comma UNLESS there is a rowtype scheme defined, and no other field definitions.

{5} the composite index definitions

You can set up your scheme to create extended tables (i.e. in Postgresql). You also can define indexes or fields seperate (i.e. in HSQL or in a create table after a create row type in Informix) or in one go (as you might do with MySQL).

See Also:

Constant Field Values

CREATE_OBJECT_TABLE_DEFAULT

public static final java.lang.String CREATE_OBJECT_TABLE_DEFAULT

The default scheme for creating a table.

See Also:

Constant Field Values

CREATE_PRIMARY_KEY

public static final java.lang.String CREATE_PRIMARY_KEY

Name of the scheme for creating a primary key. This a partial scheme that is typically included in an CREATE TABLE or ALTER TABLE scheme. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the key for

{2} the field to create the key for

See Also:

Constant Field Values

CREATE_PRIMARY_KEY_DEFAULT

public static final java.lang.String CREATE_PRIMARY_KEY_DEFAULT

The default scheme for creating a prinary key.

See Also:

Constant Field Values

CREATE_COMPOSITE_KEY

public static final java.lang.String CREATE_COMPOSITE_KEY

Name of the scheme for creating a unique composite key. This a partial scheme that is typically included in an CREATE TABLE or ALTER TABLE scheme. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the key for

{2} the field (or fieldlist) to create the key for

See Also:

Constant Field Values

CREATE_COMPOSITE_KEY_DEFAULT

public static final java.lang.String CREATE_COMPOSITE_KEY_DEFAULT

The default scheme for creating a composite key.

See Also:

Constant Field Values

CREATE_UNIQUE_KEY

public static final java.lang.String CREATE_UNIQUE_KEY

Name of the scheme for creating a unique key. This a partial scheme that is typically included in an CREATE TABLE or ALTER TABLE scheme. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the key for

{2} the field (or fieldlist) to create the key for

See Also:

Constant Field Values

CREATE_UNIQUE_KEY_DEFAULT

public static final java.lang.String CREATE_UNIQUE_KEY_DEFAULT

The default scheme for selecting a node type.

See Also:

Constant Field Values

CREATE_INDEX

public static final java.lang.String CREATE_INDEX

Name of the scheme for creating an index. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the key for

{2} the field (or fieldlist) to create the key for

See Also:

Constant Field Values

CREATE_INDEX_DEFAULT

public static final java.lang.String CREATE_INDEX_DEFAULT

The default scheme for creating an index

CREATE_FOREIGN_KEY

public static final java.lang.String CREATE_FOREIGN_KEY

Name of the scheme for creating a foreign (referential) key. This a partial scheme that is typically included in an CREATE TABLE or ALTER TABLE scheme. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to create the key for

{2} the field to create the key for

{3} the basic storage element referenced (name of the object table)

{4} the name of the number field

See Also:

Constant Field Values

CREATE_FOREIGN_KEY_DEFAULT

public static final java.lang.String CREATE_FOREIGN_KEY_DEFAULT

The default scheme for selecting a node type.

See Also:

Constant Field Values

DELETE_NODE

public static final java.lang.String DELETE_NODE

Name of the scheme for selecting a node type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to delete the node from (MMObjectBuilder), or the builder table name (String)

{2} the 'number' field (FieldDefs), or the database field name (String)

{3} the number of the object to update (Integer)

See Also:

Constant Field Values

DELETE_NODE_DEFAULT

public static final java.lang.String DELETE_NODE_DEFAULT

The default scheme for selecting a node type.

See Also:

Constant Field Values

DROP_ROW_TYPE

public static final java.lang.String DROP_ROW_TYPE

Name of the scheme for dropping a row type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to drop teh rowtype of (MMObjectBuilder), or the builder table name (String)

See Also:

Constant Field Values

DROP_TABLE

public static final java.lang.String DROP_TABLE

Name of the scheme for dropping a table. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to drop (MMObjectBuilder), or the builder table name (String)

See Also:

Constant Field Values

DROP_TABLE_DEFAULT

public static final java.lang.String DROP_TABLE_DEFAULT

The default scheme for reading a text field.

See Also:

Constant Field Values

GET_BINARY_DATA

public static final java.lang.String GET_BINARY_DATA

Name of the scheme for reading a binary field from a node. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to delete the node from (MMObjectBuilder), or the builder table name (String)

{2} the binary field (FieldDefs), or the binary field name (String)

{3} the 'number' field (FieldDefs), or the database field name (String)

{4} the number of the object to update (Integer)

See Also:

Constant Field Values

GET_BINARY_DATA_DEFAULT

public static final java.lang.String GET_BINARY_DATA_DEFAULT

The default scheme for reading a binary field.

See Also:

Constant Field Values

GET_TABLE_SIZE

public static final java.lang.String GET_TABLE_SIZE

Name of the scheme for obtaining the size of a (builder) table. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to count the node of (MMObjectBuilder), or the builder table name (String)

See Also:

Constant Field Values

GET_TABLE_SIZE_DEFAULT

public static final java.lang.String GET_TABLE_SIZE_DEFAULT

The default scheme for reading a text field.

See Also:

Constant Field Values

GET_TEXT_DATA

public static final java.lang.String GET_TEXT_DATA

Name of the scheme for reading a text field from a node. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to delete the node from (MMObjectBuilder), or the builder table name (String)

{2} the text field (FieldDefs), or the text field name (String)

{3} the 'number' field (FieldDefs), or the database field name (String)

{4} the number of the object to update (Integer)

See Also:

Constant Field Values

GET_TEXT_DATA_DEFAULT

public static final java.lang.String GET_TEXT_DATA_DEFAULT

The default scheme for reading a text field.

See Also:

Constant Field Values

INSERT_NODE

public static final java.lang.String INSERT_NODE

Name of the scheme for inserting a node. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to update (MMObjectBuilder), or the builder table name (String)

{2} A comma-separated list of fieldnames to update'

{3} A comma-separated list of value-placeholders to update (a value placehodler takes the format '?')

See Also:

Constant Field Values

INSERT_NODE_DEFAULT

public static final java.lang.String INSERT_NODE_DEFAULT

The default scheme for inserting a node type.

See Also:

Constant Field Values

SELECT_NODE

public static final java.lang.String SELECT_NODE

Name of the scheme for selecting a node. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to query (MMObjectBuilder), or the builder table name (String)

{2} the 'number' field (FieldDefs), or the database field name (String)

{3} the number to locate (Integer)

See Also:

Constant Field Values

SELECT_NODE_DEFAULT

public static final java.lang.String SELECT_NODE_DEFAULT

The default scheme for selecting a node.

See Also:

Constant Field Values

SELECT_NODE_TYPE

public static final java.lang.String SELECT_NODE_TYPE

Name of the scheme for selecting a node type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the MMBase module (MMBase), or the object table name (String)

{2} the 'number' field (FieldDefs), or the database field name (String)

{3} the number to locate (Integer)

See Also:

Constant Field Values

SELECT_NODE_TYPE_DEFAULT

public static final java.lang.String SELECT_NODE_TYPE_DEFAULT

The default scheme for selecting a node type.

See Also:

Constant Field Values

UPDATE_NODE

public static final java.lang.String UPDATE_NODE

Name of the scheme for updating a node type. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to update (MMObjectBuilder), or the builder table name (String)

{2} A comma-separated list of fields to update, in the format 'fieldname = ?'

{3} the 'number' field (FieldDefs), or the database field name (String)

{4} the number of the object to update (Integer)

See Also:

Constant Field Values

UPDATE_NODE_DEFAULT

public static final java.lang.String UPDATE_NODE_DEFAULT

The default scheme for updating a node type.

See Also:

Constant Field Values

CREATE_SEQUENCE

public static final java.lang.String CREATE_SEQUENCE

Name of the scheme for creating a sequence or number table The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the (suggested) field definition of the primary key field ('number')

See Also:

Constant Field Values

CREATE_SEQUENCE_DEFAULT

public static final java.lang.String CREATE_SEQUENCE_DEFAULT

The default scheme for creating a sequence table.

See Also:

Constant Field Values

INIT_SEQUENCE

public static final java.lang.String INIT_SEQUENCE

Name of the scheme for initializing a sequence or number table The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the (suggested) name of the primary key field ('number')

{2} the value to init the sequence to

See Also:

Constant Field Values

INIT_SEQUENCE_DEFAULT

public static final java.lang.String INIT_SEQUENCE_DEFAULT

The default scheme for initializing a sequence table.

See Also:

Constant Field Values

UPDATE_SEQUENCE

public static final java.lang.String UPDATE_SEQUENCE

Name of the scheme for updating a sequence or number table The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the (suggested) name of the primary key field ('number')

{2} the sequence buffer size (nr of keys that MMBase caches in the storage layer).

See Also:

Constant Field Values

UPDATE_SEQUENCE_DEFAULT

public static final java.lang.String UPDATE_SEQUENCE_DEFAULT

The default scheme for updating a sequence table.

See Also:

Constant Field Values

READ_SEQUENCE

public static final java.lang.String READ_SEQUENCE

Name of the scheme for retrieving the key from sequence or number table The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the (suggested) name of the primary key field ('number')

{2} the sequence buffer size (nr of keys that MMBase caches in the storage layer).

See Also:

Constant Field Values

READ_SEQUENCE_DEFAULT

public static final java.lang.String READ_SEQUENCE_DEFAULT

The default scheme for retrieving the key from a sequence table.

See Also:

Constant Field Values

CREATE_FIELD_SCHEME

public static final java.lang.String CREATE_FIELD_SCHEME

Name of the scheme for creating (adding) a field. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder of the field

{2} the field definition (excluding simple index definitions)

See Also:

Constant Field Values

CREATE_FIELD_SCHEME_DEFAULT

public static final java.lang.String CREATE_FIELD_SCHEME_DEFAULT

The default scheme for creating (adding) a field.

See Also:

Constant Field Values

CHANGE_FIELD_SCHEME

public static final java.lang.String CHANGE_FIELD_SCHEME

Name of the scheme for changing a field. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder of the field

{2} the field definition (excluding simple index definitions)

See Also:

Constant Field Values

CHANGE_FIELD_SCHEME_DEFAULT

public static final java.lang.String CHANGE_FIELD_SCHEME_DEFAULT

The default scheme for changing a field.

See Also:

Constant Field Values

DELETE_FIELD_SCHEME

public static final java.lang.String DELETE_FIELD_SCHEME

Name of the scheme for deleting a field. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder of the field

{2} the field

See Also:

Constant Field Values

DELETE_FIELD_SCHEME_DEFAULT

public static final java.lang.String DELETE_FIELD_SCHEME_DEFAULT

The default scheme for deleting a field.

See Also:

Constant Field Values

CREATE_CONSTRAINT_SCHEME

public static final java.lang.String CREATE_CONSTRAINT_SCHEME

Name of the scheme for creating (adding) a constraint, such as a key or index. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder of the field

{2} the constraint definition

See Also:

Constant Field Values

CREATE_CONSTRAINT_SCHEME_DEFAULT

public static final java.lang.String CREATE_CONSTRAINT_SCHEME_DEFAULT

The default scheme for creating (adding) a constraint.

See Also:

Constant Field Values

DELETE_CONSTRAINT_SCHEME

public static final java.lang.String DELETE_CONSTRAINT_SCHEME

Name of the scheme for deleting a constraint, such as a key or index. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder of the field

{2} the constraint name

See Also:

Constant Field Values

DELETE_CONSTRAINT_SCHEME_DEFAULT

public static final java.lang.String DELETE_CONSTRAINT_SCHEME_DEFAULT

The default scheme for deleting a constraint.

See Also:

Constant Field Values

CREATE_SECONDARY_INDEX

public static final java.lang.String CREATE_SECONDARY_INDEX

Name of the scheme for creating a secondary index. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to add the index to (MMObjectBuilder), or the builder table name (String)

{2} the field to create the key for

See Also:

Constant Field Values

To Do:

Currently not used

CREATE_SECONDARY_INDEX_DEFAULT

public static final java.lang.String CREATE_SECONDARY_INDEX_DEFAULT

The default scheme for reating a secondary index. There is no default SQL92 syntax for secondary indices, so this default is null.

DELETE_SECONDARY_INDEX

public static final java.lang.String DELETE_SECONDARY_INDEX

Name of the scheme for dropping a secondary index. The parameters accepted are:

{0} the storage manager (StorageManager), or the basename for tables (String)

{1} the builder to delete the index of (MMObjectBuilder), or the builder table name (String)

{2} the index name

See Also:

Constant Field Values

To Do:

Currently not used

DELETE_SECONDARY_INDEX_DEFAULT

public static final java.lang.String DELETE_SECONDARY_INDEX_DEFAULT

The default scheme for reating a secondary index. There is no default SQL92 syntax for secondary indices, so this default is null.

Constructor Detail

Schemes

public Schemes()