connection.h

Go to the documentation of this file.

/* (C) Copyright 2015-2023 Dassault Systemes SE.  All Rights Reserved. */
 
#ifndef _NUODB_CONNECTION_H_
#define _NUODB_CONNECTION_H_ 1
 
#ifndef _NUODB_UTILS_H_
#include "nuodb/utils.h"
#endif
 
#ifndef _NUODB_STRUCTS_H_
#include "nuodb/structs.h"
#endif
 
#ifndef _NUODB_ERROR_H_
#include "nuodb/error.h"
#endif
 
/* c-driver */
#ifdef __cplusplus
extern "C" {
#endif
 
enum NuoDB_TransactionIsolationLevel_enum {
    NUODB_TXN_ISOLATION_READ_COMMITTED = 2,
 
    NUODB_TXN_ISOLATION_WRITE_COMMITTED = 5,
 
    NUODB_TXN_ISOLATION_CONSISTENT_READ = 7,   /* NuoDB Default */
 
    NUODB_TXN_ISOLATION_SERIALIZABLE = 8,
};
 
 
typedef enum NuoDB_TransactionIsolationLevel_enum  NuoDB_TransactionIsolationLevel;
 
struct NuoDB_Connection
{
    _NuoDB_Connection_state_t* _state;
 
    NuoDB_Status (* commit)(NuoDB_Connection* connection);
 
    char* (* convertUtf8ToLocal)(NuoDB_Connection* connection, const char* s, size_t sLen);
 
    const char* (* getActiveEncoding)(NuoDB_Connection* connection);
 
    NuoDB_Status (* getAutoCommit)(NuoDB_Connection* connection, nuodb_bool_t* autoCommit);
 
    int (* getConnectionVersion)(NuoDB_Connection* connection);
 
    const char* (* getDefaultEncoding)(NuoDB_Connection* connection);
 
    NuoDB_DatabaseMetaData* (* getMetaData)(NuoDB_Connection* connection);
 
    NuoDB_Status (* getSchema)(NuoDB_Connection* connection, char** schemaName, size_t* length);
 
    NuoDB_Status (* getTransactionIsolation)(NuoDB_Connection* connection, NuoDB_TransactionIsolationLevel* isolationLevel);
 
    nuodb_bool_t (* isConnected)(NuoDB_Connection* connection);
 
    nuodb_bool_t (* isReadOnly)(NuoDB_Connection* connection);
 
    nuodb_bool_t (* isUtf8)(NuoDB_Connection* connection);
 
    NuoDB_Status (* openDatabase)(NuoDB_Connection* connection,
                         const char* dbname,
                         const char* user,
                         const char* password,
                         NuoDB_Options* options);
    NuoDB_Status (* ping)(NuoDB_Connection* connection);
 
    NuoDB_Status (* rollback)(NuoDB_Connection* connection);
 
    NuoDB_Status (* setAutoCommit)(NuoDB_Connection* connection, nuodb_bool_t autoCommit);
 
    NuoDB_Status (* setReadOnly)(NuoDB_Connection* connection,
                        nuodb_bool_t readOnly);
 
 
    NuoDB_Status (* setTransactionIsolation)(NuoDB_Connection* connection,
                NuoDB_TransactionIsolationLevel level);
 
    NuoDB_Status (* setConverter)(NuoDB_Connection* connection,
                         const char* encoding);
 
    NuoDB_Status (* setDefaultConverter)(NuoDB_Connection* connection,
                                const char* encoding);
 
    int (* getProtocolVersion)(NuoDB_Connection* connection);
 
 
    const char* (* getConnectionURL)(NuoDB_Connection* connection);
 
    NuoDB_Status (* openDatabaseEngine)(NuoDB_Connection* connection,
                         void* nuoEngine,
                         const char* user,
                         const char* password,
                         NuoDB_Options* options);
 
    NuoDB_Status (* getNextSequenceValue)(NuoDB_Connection* connection, const char* schema, const char* sequenceName, int64_t* sequence);
 
    NuoDB_EngineHandle* (* getEngineHandle)(NuoDB_Connection* connection);
};
 
NUODB_CAPI const char* NUODB_CAPICALL NuoDB_getDriverVersion(unsigned int* majorVersion,
                                                             unsigned int* minorVersion);
 
NUODB_CAPI NuoDB_Connection* NUODB_CAPICALL NuoDB_Connection_create();
 
NUODB_CAPI NuoDB_Connection* NUODB_CAPICALL NuoDB_Connection_createUtf8();
 
NUODB_CAPI void NUODB_CAPICALL NuoDB_Connection_free(NuoDB_Connection* connection);
 
NUODB_CAPI void NUODB_CAPICALL NuoDB_Connection_freeLocal(const char* localBuffer);
 
#ifdef __cplusplus
} /* extern "C" { */
#endif
 
#endif /* end of: #ifndef _NUODB_CONNECTION_H_ */