Qore Schema Module Reference  1.2
Schema Namespace Reference

this namespace contains all public definitions in the Schema module More...

Classes

class  AbstractSchema
 the AbstractSchema class is a base class to assist with automatic schema management More...
 
class  AbstractVersionedSchema
 this class extends Schema::AbstractSchema by providing version logic based on a schema version string contained within the schema itself More...
 
class  SchemaCallbackHelper
 this class provides callback support for schema operations More...
 

Functions

hash< GenericColumnInfo > c_blob (bool notnull=False, *string comment)
 returns a column hash for a BLOB column More...
 
hash< GenericColumnInfo > c_blob (string comment)
 returns a column hash for a BLOB column More...
 
hash< GenericColumnInfo > c_char (int size, bool notnull=False, *string comment)
 returns a column hash for a CHAR column More...
 
hash< GenericColumnInfo > c_char (int size, string comment)
 returns a column hash for a CHAR column More...
 
hash< GenericColumnInfo > c_clob (bool notnull=False, *string comment)
 returns a column hash for a CLOB column More...
 
hash< GenericColumnInfo > c_clob (string comment)
 returns a column hash for a CLOB column More...
 
hash< GenericColumnInfo > c_date (bool notnull=False, *string comment)
 returns a column hash for a DATE column More...
 
hash< GenericColumnInfo > c_date (string comment)
 returns a column hash for a DATE column More...
 
hash< GenericColumnInfo > c_int (bool notnull=False, *string comment)
 returns a column hash for an INT column More...
 
hash< GenericColumnInfo > c_int (string comment)
 returns a column hash for an INT column More...
 
hash< GenericColumnInfo > c_number (bool notnull=False, *string comment)
 returns a column hash for a NUMBER or NUMERIC column More...
 
hash< GenericColumnInfo > c_number (int size, int scale, bool notnull=False, *string comment)
 returns a column hash for a NUMBER or NUMERIC column More...
 
hash< GenericColumnInfo > c_number (int size, bool notnull=False, *string comment)
 returns a column hash for a NUMBER or NUMERIC column More...
 
hash< GenericColumnInfo > c_number (int size, string comment)
 returns a column hash for a NUMBER or NUMERIC column More...
 
hash< GenericColumnInfo > c_timestamp (bool notnull=False, *string comment)
 returns a column hash for a TIMESTAMP column More...
 
hash< GenericColumnInfo > c_timestamp (string comment)
 returns a column hash for a TIMESTAMP column More...
 
hash< GenericColumnInfo > c_varchar (int size, bool notnull=False, *string comment)
 returns a column hash for a VARCHAR column More...
 
hash< GenericColumnInfo > c_varchar (int size, string comment)
 returns a column hash for a VARCHAR column More...
 

Variables

const C_NOT_NULL = True
 Helper constant for column hash functions with "NOT NULL" constraint for better readability.
 
const C_NULL = False
 Helper constant for column hash functions with "NULL" constraint for better readability.
 

Detailed Description

this namespace contains all public definitions in the Schema module

Function Documentation

◆ c_blob() [1/2]

hash<GenericColumnInfo> Schema::c_blob ( bool  notnull = False,
*string  comment 
)

returns a column hash for a BLOB column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_clob()

◆ c_blob() [2/2]

hash<GenericColumnInfo> Schema::c_blob ( string  comment)

returns a column hash for a BLOB column

Parameters
commentthe comment for the column
See also
c_clob()

◆ c_char() [1/2]

hash<GenericColumnInfo> Schema::c_char ( int  size,
bool  notnull = False,
*string  comment 
)

returns a column hash for a CHAR column

Parameters
sizethe size of the column
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column

◆ c_char() [2/2]

hash<GenericColumnInfo> Schema::c_char ( int  size,
string  comment 
)

returns a column hash for a CHAR column

Parameters
sizethe size of the column
commentthe comment for the column

◆ c_clob() [1/2]

hash<GenericColumnInfo> Schema::c_clob ( bool  notnull = False,
*string  comment 
)

returns a column hash for a CLOB column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_blob()

◆ c_clob() [2/2]

hash<GenericColumnInfo> Schema::c_clob ( string  comment)

returns a column hash for a CLOB column

Parameters
commentthe comment for the column
See also
c_blob()

◆ c_date() [1/2]

hash<GenericColumnInfo> Schema::c_date ( bool  notnull = False,
*string  comment 
)

returns a column hash for a DATE column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_timestamp()

◆ c_date() [2/2]

hash<GenericColumnInfo> Schema::c_date ( string  comment)

returns a column hash for a DATE column

Parameters
commentthe comment for the column
See also
c_timestamp()

◆ c_int() [1/2]

hash<GenericColumnInfo> Schema::c_int ( bool  notnull = False,
*string  comment 
)

returns a column hash for an INT column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
Note
might be a numeric type if INT is not supported by the dataserver
See also
c_number()

◆ c_int() [2/2]

hash<GenericColumnInfo> Schema::c_int ( string  comment)

returns a column hash for an INT column

Parameters
commentthe comment for the column
Note
might be a numeric type if INT is not supported by the dataserver
See also
c_number()

◆ c_number() [1/4]

hash<GenericColumnInfo> Schema::c_number ( bool  notnull = False,
*string  comment 
)

returns a column hash for a NUMBER or NUMERIC column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_int()

◆ c_number() [2/4]

hash<GenericColumnInfo> Schema::c_number ( int  size,
int  scale,
bool  notnull = False,
*string  comment 
)

returns a column hash for a NUMBER or NUMERIC column

Parameters
sizethe size of the column
scalethe scale of the column
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_int()

◆ c_number() [3/4]

hash<GenericColumnInfo> Schema::c_number ( int  size,
bool  notnull = False,
*string  comment 
)

returns a column hash for a NUMBER or NUMERIC column

Parameters
sizethe size of the column
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_int()

◆ c_number() [4/4]

hash<GenericColumnInfo> Schema::c_number ( int  size,
string  comment 
)

returns a column hash for a NUMBER or NUMERIC column

Parameters
sizethe size of the column
commenta comment for the column
See also
c_int()

◆ c_timestamp() [1/2]

hash<GenericColumnInfo> Schema::c_timestamp ( bool  notnull = False,
*string  comment 
)

returns a column hash for a TIMESTAMP column

Parameters
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column
See also
c_date()

◆ c_timestamp() [2/2]

hash<GenericColumnInfo> Schema::c_timestamp ( string  comment)

returns a column hash for a TIMESTAMP column

Parameters
commentthe comment for the column
See also
c_date()

◆ c_varchar() [1/2]

hash<GenericColumnInfo> Schema::c_varchar ( int  size,
bool  notnull = False,
*string  comment 
)

returns a column hash for a VARCHAR column

Parameters
sizethe size of the column
notnullTrue for a NOT NULL constraint on the column. See constants Schema::C_NULL and Schema::C_NOT_NULL
commentan optional comment for the column

◆ c_varchar() [2/2]

hash<GenericColumnInfo> Schema::c_varchar ( int  size,
string  comment 
)

returns a column hash for a VARCHAR column

Parameters
sizethe size of the column
commentthe comment for the column