databaseMetaData.h File Reference

Metadata about a NuoDB database. More...

#include "nuodb/utils.h"
#include "nuodb/structs.h"
#include "nuodb/connection.h"

Go to the source code of this file.

Data Structures
struct	NuoDB_DatabaseMetaData
	Metadata about a NuoDB database. More...

Typedefs
typedef enum NuoDB_FunctionColumnTypes_enum	NuoDB_FunctionColumnTypes
	NuoDB Procedure MetaData Flags Enum.
typedef enum NuoDB_FunctionTypes_enum	NuoDB_FunctionTypes
	NuoDB Function MetaData Flags Enum.
typedef enum NuoDB_ImportedKeyFlags_enum	NuoDB_ImportedKeyFlags
	NuoDB Function MetaData Flags Enum.
typedef enum NuoDB_Nullable_enum	NuoDB_Nullable
	NuoDB Nullable Flags Enum.
typedef enum NuoDB_ProcedureColumnFlags_enum	NuoDB_ProcedureColumnFlags
	NuoDB Procedure MetaData Flags Enum.
typedef enum NuoDB_ProcedureFlags_enum	NuoDB_ProcedureFlags
	NuoDB Procedure MetaData Flags Enum.
typedef enum NuoDB_TableIndexTypes_enum	NuoDB_TableIndexTypes
	NuoDB Procedure MetaData Flags Enum.
typedef enum NuoDB_TypeInfoFlags_enum	NuoDB_TypeInfoFlags
	NuoDB Procedure MetaData Flags Enum.

Enumerations
enum	NuoDB_FunctionColumnTypes_enum {   NUODB_FUNCTIONCOLUMN_UNKNOWN = 0 ,   NUODB_FUNCTIONCOLUMN_IN = 1 ,   NUODB_FUNCTIONCOLUMN_INOUT = 2 ,   NUODB_FUNCTIONCOLUMN_OUT = 3 ,   NUODB_FUNCTIONCOLUMN_RETURN = 4 ,   NUODB_FUNCTIONCOLUMN_RESULT = 5 }
	NuoDB Function Column Types Enum. More...
enum	NuoDB_FunctionTypes_enum {   NUODB_FUNCTION_NOTABLE = 1 ,   NUODB_FUNCTION_RETURNSTABLE = 2 }
	NuoDB Function Types Enum. More...
enum	NuoDB_ImportedKeyFlags_enum {   NUODB_IMPORTEDKEY_CASCADE = 0 ,   NUODB_IMPORTEDKEY_SETNULL = 2 ,   NUODB_IMPORTEDKEY_NOACTION = 3 ,   NUODB_IMPORTEDKEY_SETDEFAULT = 4 ,   NUODB_IMPORTEDKEY_INITIALLYDEFERRED = 5 ,   NUODB_IMPORTEDKEY_INITIALLYIMMEDIATE = 6 ,   NUODB_IMPORTEDKEY_NOTDEFERRABLE = 7 }
	NuoDB Function Types Enum. More...
enum	NuoDB_Nullable_enum {   NUODB_NULLABLE_NONULLS = 0 ,   NUODB_NULLABLE_NULLABLE = 1 ,   NUODB_NULLABLE_UNKNOWN = 2 }
	NuoDB Nullable MetaData Enum. More...
enum	NuoDB_ProcedureColumnFlags_enum {   NUODB_PROCEDURECOLUMN_UNKNOWN = 0 ,   NUODB_PROCEDURECOLUMN_IN = 1 ,   NUODB_PROCEDURECOLUMN_INOUT = 2 ,   NUODB_PROCEDURECOLUMN_OUT = 4 ,   NUODB_PROCEDURECOLUMN_RETURN = 5 ,   NUODB_PROCEDURECOLUMN_RESULT = 3 }
	NuoDB Procedure Column MetaData Flags Enum. More...
enum	NuoDB_ProcedureFlags_enum {   NUODB_PROCEDURE_RESULTUNKNOWN = 0 ,   NUODB_PROCEDURE_NORESULT = 1 ,   NUODB_PROCEDURE_RETURNSRESULT = 2 }
	NuoDB Procedure MetaData Flags Enum. More...
enum	NuoDB_TableIndexTypes_enum {   NUODB_TABLEINDEX_STATISTIC = 0 ,   NUODB_TABLEINDEX_CLUSTERED = 1 ,   NUODB_TABLEINDEX_HASHED = 2 ,   NUODB_TABLEINDEX_OTHER = 3 }
	NuoDB Tabled Index Types Enum. More...
enum	NuoDB_TypeInfoFlags_enum {   NUODB_TYPE_PREDNONE = 0 ,   NUODB_TYPE_PREDCHAR = 1 ,   NUODB_TYPE_PREDBASIC = 2 ,   NUODB_TYPE_SEARCHABLE = 3 }
	NuoDB Procedure Column MetaData Flags Enum. More...

Detailed Description

Metadata about a NuoDB database.

Enumeration Type Documentation

NuoDB_FunctionColumnTypes_enum

enum NuoDB_FunctionColumnTypes_enum

NuoDB Function Column Types Enum.

Enumerator
NUODB_FUNCTIONCOLUMN_UNKNOWN	Indicates that type of the parameter or column is unknown. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().
NUODB_FUNCTIONCOLUMN_IN	Indicates that the parameter or column is an IN parameter. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().
NUODB_FUNCTIONCOLUMN_INOUT	Indicates that the parameter or column is an INOUT parameter. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().
NUODB_FUNCTIONCOLUMN_OUT	Indicates that the parameter or column is an OUT parameter. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().
NUODB_FUNCTIONCOLUMN_RETURN	Indicates that the parameter or column is a return value. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().
NUODB_FUNCTIONCOLUMN_RESULT	Indicates that the parameter or column is a column in a result set. A possible value for column COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctionColumns().

NuoDB_FunctionTypes_enum

enum NuoDB_FunctionTypes_enum

NuoDB Function Types Enum.

Enumerator
NUODB_FUNCTION_NOTABLE	Indicates that the function does not return a table. A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctions().
NUODB_FUNCTION_RETURNSTABLE	Indicates that the function returns a table. A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctions().

NuoDB_ImportedKeyFlags_enum

enum NuoDB_ImportedKeyFlags_enum

NuoDB Function Types Enum.

Enumerator
NUODB_IMPORTEDKEY_CASCADE	Indicates that the function does not return a table. A possible value for column FUNCTION_TYPE in the ResultSet object returned by the method DatabaseMetaData::getFunctions().

NuoDB_Nullable_enum

enum NuoDB_Nullable_enum

NuoDB Nullable MetaData Enum.

Enumerator
NUODB_NULLABLE_NONULLS	Indicates that NULL values are not allowed. A possible column value for NULLABLE in any ResultSet object returned by DatabaseMetaData methods
NUODB_NULLABLE_NULLABLE	Indicates that NULL values are allowed. A possible column value for NULLABLE in any ResultSet object returned by DatabaseMetaData methods
NUODB_NULLABLE_UNKNOWN	Indicates that whether NULL values are allowed is unknown. A possible column value for NULLABLE in any ResultSet object returned by DatabaseMetaData methods

NuoDB_ProcedureColumnFlags_enum

enum NuoDB_ProcedureColumnFlags_enum

NuoDB Procedure Column MetaData Flags Enum.

Enumerator
NUODB_PROCEDURECOLUMN_UNKNOWN	Indicates that the column type is unknown. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()
NUODB_PROCEDURECOLUMN_IN	Indicates that the column stores IN parameters. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()
NUODB_PROCEDURECOLUMN_INOUT	Indicates that the column stores INOUT parameters. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()
NUODB_PROCEDURECOLUMN_OUT	Indicates that the column stores OUT parameters. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()
NUODB_PROCEDURECOLUMN_RETURN	Indicates that the column stores return parameters. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()
NUODB_PROCEDURECOLUMN_RESULT	Indicates that the column stores results. A possible column value for COLUMN_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedureColumns()

NuoDB_ProcedureFlags_enum

enum NuoDB_ProcedureFlags_enum

NuoDB Procedure MetaData Flags Enum.

Enumerator
NUODB_PROCEDURE_RESULTUNKNOWN	Indicates that it is not known if the procedure returns a result. A possible column value for PROCEDURE_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedures()
NUODB_PROCEDURE_NORESULT	Indicates that the procedure does not return a result. A possible column value for PROCEDURE_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedures()
NUODB_PROCEDURE_RETURNSRESULT	Indicates that the procedure returns a result. A possible column value for PROCEDURE_TYPE in the ResultSet object returned by the method DatabaseMetaData::getProcedures()

NuoDB_TableIndexTypes_enum

enum NuoDB_TableIndexTypes_enum

NuoDB Tabled Index Types Enum.

Enumerator
NUODB_TABLEINDEX_OTHER	Indicates that this table index is not a clustered index, a hashed index or table statistics; it is something other than these. A possible value for column TYPE in the ResultSet object returned by the method DatabaseMetaData::getIndexInfo().

NuoDB_TypeInfoFlags_enum

enum NuoDB_TypeInfoFlags_enum

NuoDB Procedure Column MetaData Flags Enum.

Enumerator
NUODB_TYPE_PREDNONE	WHERE search clauses are not supported for this type. A possible value for the column SEARCHABLE in the ResultSet object returned by DatabaseMetaData::getTypeInfo()
NUODB_TYPE_PREDCHAR	The data type can be only used in WHERE search clauses that use LIKE predicates. A possible value for the column SEARCHABLE in the ResultSet object returned by DatabaseMetaData::getTypeInfo()
NUODB_TYPE_PREDBASIC	The data type can only be used in WHERE search clauses that do not use LIKE predicates. A possible value for the column SEARCHABLE in the ResultSet object returned by DatabaseMetaData::getTypeInfo()
NUODB_TYPE_SEARCHABLE	All WHERE search clauses can be used on this type. A possible value for the column SEARCHABLE in the ResultSet object returned by DatabaseMetaData::getTypeInfo()