 |
rasdaman client API
10.6.3
The Array Analytics Engine: Datacubes at Your Fingertips
|
Go to the documentation of this file.
24 #ifndef CLIENTCOMM_HH_
25 #define CLIENTCOMM_HH_
65 virtual int createDB(
const char *name) = 0;
67 virtual int destroyDB(
const char *name) = 0;
77 virtual int openTA(
unsigned short readOnly = 0) = 0;
103 virtual void insertColl(
const char *collName,
const char *typeName,
const r_OId &oid) = 0;
178 virtual void setMaxRetry(
unsigned int newMaxRetry) = 0;
The class ClientComm represents one connection between one client entity (for example an object of cl...
Definition: clientcomm.hh:50
virtual void updateTransaction()
resets to the global r_Transaction::actual_transaction if necessary
virtual int setTransferFormat(r_Data_Format format, const char *formatParams=NULL)=0
Configuration methods.
virtual char * getTypeStructure(const char *typeName, r_Type_Type typeType)=0
get type structure deallocate using delete []
void setDatabase(r_Database *database)
sets the database that is using this client communicator
virtual unsigned short getObjectType(const r_OId &oid)=0
get oid type
virtual unsigned int getMaxRetry()=0
get maximum retry to get a server
virtual void insertColl(const char *collName, const char *typeName, const r_OId &oid)=0
Collection methods.
virtual r_Ref_Any getCollOIdsByName(const char *name)=0
gets collection references by name
virtual void executeQuery(const r_OQL_Query &query, r_Set< r_Ref_Any > &result)=0
Query methods.
virtual r_Ref_Any getCollByName(const char *name)=0
gets collection by name
The class r_Ref_Any is defined to support a reference to any type.
Definition: ref.hh:64
virtual r_OId getNewOId(unsigned short objType)=0
System methods.
virtual void setUserIdentification(const char *userName, const char *plainTextPassword)=0
user identification for RasMGR
This class is the superclass of the types r_Structure_Type and r_Primitive_Type in the representation...
Definition: basetype.hh:39
virtual int closeDB()=0
close current database
r_Data_Format
\begin{tabular}{ll} <tt>r_Array</tt> && no compression, row-major memory representation\...
Definition: mddtypes.hh:93
virtual r_Ref_Any getMDDByOId(const r_OId &oid)=0
gets MDD object by oid
virtual void deleteObjByOId(const r_OId &oid)=0
deletes an object by oid (right now, objects are collection only)
virtual int createDB(const char *name)=0
create a database
virtual ~ClientComm()=default
destructor (closes the connection and releases resources)
virtual r_Ref_Any getCollOIdsByOId(const r_OId &oid)=0
gets collection references by oid
virtual int commitTA()=0
commit current transaction
The class implements a set container.
Definition: oqlquery.hh:31
virtual void deleteCollByName(const char *collName)=0
deletes an MDD collection by name
Transactions can be started, committed, aborted, and checkpointed.
Definition: transaction.hh:49
r_Type_Type
Definition: clientcomm.hh:152
virtual int destroyDB(const char *name)=0
destroy a database
r_Transaction * transaction
reference to the transaction being used by this client communicator
Definition: clientcomm.hh:205
virtual int openDB(const char *database)=0
Database methods.
virtual r_Ref_Any getCollByOId(const r_OId &oid)=0
gets collection by oid
virtual int getTimeoutInterval()=0
get communication timeout interval in seconds.
ClientComm()=default
constructor getting nothing
@ r_MDDType_Type
Definition: clientcomm.hh:155
virtual void removeObjFromColl(const char *name, const r_OId &oid)=0
removes an object from a collection
The class represents a generic MDD in the sense that it is independent of the cell base type.
Definition: gmarray.hh:65
virtual void setMaxRetry(unsigned int newMaxRetry)=0
set maximum retry to get a server
A database object must be instantiated and opened before starting any transaction which uses the data...
Definition: database.hh:59
Class for parsing a string consisting of key=value pairs separated by ",".
Definition: parseparams.hh:39
virtual void setTimeoutInterval(int seconds)=0
set communication timeout interval in seconds.
virtual int abortTA()=0
abort current transaction
Class r_OId represents an object identifier.
Definition: oid.hh:38
r_Database * database
reference to the database that created this client communicator
Definition: clientcomm.hh:202
virtual int openTA(unsigned short readOnly=0)=0
Transaction methods.
void setTransaction(r_Transaction *transaction)
sets the transaction that is using this client communicator
@ r_SetType_Type
Definition: clientcomm.hh:154
virtual int setStorageFormat(r_Data_Format format, const char *formatParams=NULL)=0
set the preferred storage format
virtual void insertMDD(const char *collName, r_GMarray *mar)=0
MDD methods.
The global function r_oql_execute() is used to invoke RasML queries.
Definition: oqlquery.hh:70