databaseMetaData.h

Go to the documentation of this file.

/* (C) Copyright 2015-2023 Dassault Systemes SE.  All Rights Reserved. */
 
#ifndef _NUODB_DATABASEMETADATA_H_
#define _NUODB_DATABASEMETADATA_H_ 1
 
#ifndef _NUODB_UTILS_H_
#include "nuodb/utils.h"
#endif
 
#ifndef _NUODB_STRUCTS_H_
#include "nuodb/structs.h"
#endif
 
#ifndef _NUODB_CONNECTION_H_
#include "nuodb/connection.h"
#endif
 
/* c-driver */
#ifdef __cplusplus
extern "C" {
#endif
 
enum NuoDB_ProcedureFlags_enum {
    NUODB_PROCEDURE_RESULTUNKNOWN = 0,
 
    NUODB_PROCEDURE_NORESULT = 1,
 
    NUODB_PROCEDURE_RETURNSRESULT = 2,
};
 
typedef enum NuoDB_ProcedureFlags_enum  NuoDB_ProcedureFlags;
 
 
enum NuoDB_Nullable_enum {
    NUODB_NULLABLE_NONULLS = 0,
 
    NUODB_NULLABLE_NULLABLE = 1,
 
    NUODB_NULLABLE_UNKNOWN = 2
};
 
typedef enum NuoDB_Nullable_enum  NuoDB_Nullable;
 
 
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,
};
 
typedef enum NuoDB_ProcedureColumnFlags_enum  NuoDB_ProcedureColumnFlags;
 
 
enum NuoDB_TypeInfoFlags_enum {
    NUODB_TYPE_PREDNONE = 0,
 
    NUODB_TYPE_PREDCHAR = 1,
 
    NUODB_TYPE_PREDBASIC = 2,
 
    NUODB_TYPE_SEARCHABLE = 3
};
 
typedef enum NuoDB_TypeInfoFlags_enum  NuoDB_TypeInfoFlags;
 
 
enum NuoDB_TableIndexTypes_enum {
    NUODB_TABLEINDEX_STATISTIC = 0,
    NUODB_TABLEINDEX_CLUSTERED = 1,
    NUODB_TABLEINDEX_HASHED = 2,
 
    NUODB_TABLEINDEX_OTHER = 3
};
 
typedef enum NuoDB_TableIndexTypes_enum  NuoDB_TableIndexTypes;
 
 
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
};
 
typedef enum NuoDB_FunctionColumnTypes_enum  NuoDB_FunctionColumnTypes;
 
 
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
};
 
typedef enum NuoDB_ImportedKeyFlags_enum  NuoDB_ImportedKeyFlags;
 
enum NuoDB_FunctionTypes_enum {
    NUODB_FUNCTION_NOTABLE = 1,
 
    NUODB_FUNCTION_RETURNSTABLE = 2
};
 
typedef enum NuoDB_FunctionTypes_enum  NuoDB_FunctionTypes;
 
struct NuoDB_DatabaseMetaData
{
    _NuoDB_DatabaseMetaData_state_t* _state;
 
    const char* (* getConnectionURL)(NuoDB_DatabaseMetaData* _this);
 
    const char* (* getDatabaseProductName)(NuoDB_DatabaseMetaData* _this);
 
    const char* (* getDatabaseProductVersion)(NuoDB_DatabaseMetaData* _this);
 
    const char* (* getDatabaseVersion)(NuoDB_DatabaseMetaData* _this,
                        unsigned int* majorVersion,
                        unsigned int* minorVersion);
 
    nuodb_bool_t (* supportsTransactionIsolationLevel)(NuoDB_DatabaseMetaData* _this,
                         NuoDB_TransactionIsolationLevel level);
 
    NuoDB_ResultSet* (* getProcedures)(NuoDB_DatabaseMetaData* _this,
                           const char* schemaPattern,
                           const char* procedureNamePattern);
 
    NuoDB_ResultSet* (* getProcedureColumns)(NuoDB_DatabaseMetaData* _this,
                           const char* schemaPattern,
                           const char* procedureNamePattern,
                           const char* columnNamePattern);
 
    NuoDB_ResultSet* (* getTables)(NuoDB_DatabaseMetaData* _this,
                                   const char*  schemaPattern,
                                   const char*  tableNamePattern,
                                   int          typeCount,
                                   const char** types);
 
    NuoDB_ResultSet* (* getSchemas)(NuoDB_DatabaseMetaData* _this);
 
    NuoDB_ResultSet* (* getTableTypes)(NuoDB_DatabaseMetaData* _this);
 
    NuoDB_ResultSet* (* getColumns)(NuoDB_DatabaseMetaData* _this,
                           const char* schemaPattern,
                           const char* tableNamePattern,
                           const char* columnNamePattern);
 
    NuoDB_ResultSet* (* getPrimaryKeys)(NuoDB_DatabaseMetaData* _this,
                           const char* schema,
                           const char* table);
 
    NuoDB_ResultSet* (* getImportedKeys)(NuoDB_DatabaseMetaData* _this,
                           const char* schema,
                           const char* table);
 
    NuoDB_ResultSet* (* getTypeInfo)(NuoDB_DatabaseMetaData* _this);
 
    NuoDB_ResultSet* (* getIndexInfo)(NuoDB_DatabaseMetaData* _this,
                           const char* schema,
                           const char* table,
                           nuodb_bool_t unique);
 
    NuoDB_ResultSet* (* getFunctions)(NuoDB_DatabaseMetaData* _this,
                           const char* schemaPattern,
                           const char* functionNamePattern);
 
    NuoDB_ResultSet* (* getFunctionColumns)(NuoDB_DatabaseMetaData* _this,
                           const char* schemaPattern,
                           const char* functionNamePattern,
                           const char* columnNamePattern);
 
    NuoDB_ResultSet* (* getTriggers)(NuoDB_DatabaseMetaData* _this,
                                     const char* schemaPattern,
                                     const char* tableNamePattern,
                                     const char* triggerNamePattern);
 
    int (* getDriverMajorVersion)(NuoDB_DatabaseMetaData* _this);
 
    int (* getDriverMinorVersion)(NuoDB_DatabaseMetaData* _this);
};
 
#ifdef __cplusplus
} /* extern "C" { */
#endif
 
#endif /* end of: #ifndef _NUODB_DATABASEMETADATA_H_ */