Purpose:
This class is a specific version of dkDatastore to implement the OnDemand datastore. It provides documents storage, a retrieval mechanism as well as query and search abilities, along with other document processing features supported by the OnDemand datastore. The execute() and evaluate() functions of DKDatastoreOD take query strings expressed in SQL query language type as well as other query objects.
Class summary:
class DKEXPORT DKDatastoreOD: public dkDatastore { public: DKDatastoreOD(); DKDatastoreOD(DKString configuration); virtual ~DKDatastoreOD(); virtual void connect(const char* datastore_name, const char* user_name = "", const char* authentication = "", const char* connect_string = ""); virtual void disconnect(); virtual void getOption(long option, DKAny& value); virtual void setOption(long option, DKAny& value); virtual DKAny evaluate(const char* command, const short commandLangType, const DKNVPair* params = 0); virtual DKAny evaluate(dkQuery* query); virtual DKAny evaluate(DKCQExpr* qe); virtual DKAny evaluate(dkSearchTemplate* st); virtual dkResultSetCursor* execute(const char* command, const short commandLangType, const DKNVPair* params); virtual dkResultSetCursor* execute(dkSearchTemplate* st); virtual dkResultSetCursor* execute(dkSearchTemplate* st, const DKNVPair* params, const DKNVPair* options); virtual dkResultSetCursor* execute(dkQuery* query); virtual dkResultSetCursor* execute(DKCQExpr* cqe); virtual void executeWithCallback(const char* command, const short commandLangType, const DKNVPair* params, dkCallback* callbackObj); virtual void executeWithCallback(dkQuery* query, dkCallback* callbackObj); virtual void executeWithCallback(DKCQExpr* qe, dkCallback* callbackObj); virtual void executeWithCallback(dkSearchTemplate* st, dkCallback* callbackObj); virtual void executeWithCallback(DKFolderOD* st, const DKNVPair* params, dkCallback* callbackObj); virtual dkQuery* createQuery(const char* command, const short commandLangType, const DKNVPair* params=0); virtual dkQuery* createQuery(DKCQExpr* qe); virtual void addObject(dkDataObject* ddo); virtual void deleteObject(dkDataObject* ddo); virtual void retrieveObject(dkDataObject* ddo); virtual void updateObject(dkDataObject* ddo); virtual void commit(); virtual void rollback(); virtual DKBoolean isConnected(); virtual DKString datastoreName() const; virtual DKString datastoreType() const; virtual DKString userName() const; virtual DKHandle* connection(); virtual DKHandle* handle(const char* type); virtual dkCollection* listDataSources(); virtual DKString* listDataSourceNames(long& arraySize); virtual DKAny listServers(); virtual DKAny listSchema(); virtual DKAny listSchemaAttributes(const char* schemaEntry); virtual dkCollection* listSearchableEntities(); virtual dkCollection* listEntities(); virtual DKString* listEntityNames(long& arraySize); virtual dkCollection* listSearchTemplates(); virtual dkCollection* listEntityAttrs(const char* entityName); virtual DKString* listEntityAttrNames(const char* entityName, long& arraySize); virtual dkDatastoreDef* datastoreDef(); virtual DKString registerMapping(DKNVPair* sourceMap); virtual void unRegisterMapping(const char* mappingName); virtual DKString* listMappingNames(long& arraySize); virtual dkSchemaMapping* getMapping(const char* mappingName); virtual dkExtension* getExtension(const char* extensionName); virtual void addExtension(const char* extensionName, dkExtension* extensionObj); virtual void removeExtension(const char* extensionName); virtual DKString* listExtensionNames(long& arraySize); virtual DKDDO* createDDO(const char* objectType, long Flags); void changePassword(DKString userId, DKString oldPwd, DKString newPwd); DKCQExpr* translate(DKCQExpr* cqe); };
Members:
DKDatastoreOD(); DKDatastoreOD(const char* configuration); virtual ~DKDatastoreOD();
keyword1=value1;keyword2=value2;keyword3=value3 Supported keywords and values for the connection string are:
void setDatastore(dkDatastore* ds);
[1] This option is on. [Anything else] This option is off (default).
[1] This option is on. [Anything else] This option is off (default).
This option is not currently supported.
The valid values are:
virtual void connect (const char* datastore_name, const char* user_name = "", const char* authentication = "", const char* connect_string = "");
virtual void disconnect();
The valid options are:
The valid options and values are as follows:
The valid values are:
virtual DKAny evaluate(const char* command, const short commandLangType, const DKNVPair* params = 0); virtual DKAny evaluate(dkQuery* query); virtual DKAny evaluate(DKCQExpr* qe); virtual DKAny evaluate(dkSearchTemplate* st);
virtual dkResultSetCursor* execute(const char* command, const short commandLangType, const DKNVPair* params); virtual dkResultSetCursor* execute(dkSearchTemplate* st); virtual dkResultSetCursor* execute(dkSearchTemplate* st, const DKNVPair* params, const DKNVPair* options); virtual dkResultSetCursor* execute(dkQuery* query); virtual dkResultSetCursor* execute(DKCQExpr* cqe);
virtual void executeWithCallback(const char* command, const short commandLangType, cnst DKNVPair* params, dkCallback* callbackObj); virtual void executeWithCallback(dkQuery* query, dkCallback* callbackObj); virtual void executeWithCallback(DKCQExpr* qe, dkCallback* callbackObj); virtual void executeWithCallback(dkSearchTemplate* st, dkCallback* callbackObj); virtual void executeWithCallback(DKFolderOD* st, const DKNVPair* params, dkCallback* callbackObj);
virtual dkQuery* createQuery(const char* command, const short commandLangType, const DKNVPair* params=0); virtual dkQuery* createQuery(DKCQExpr* qe);
void addObject(dkDataObject* dataObject);
void deleteObject(dkDataObject* dataObject);
void retrieveObject(dkDataObject* dataObject);
void updateObject(dkDataObject* dataObject);
virtual void commit ();
virtual void rollback ();
virtual DKBoolean isConnected();
virtual DKHandle* connection();
virtual DKHandle* handle(const char* type);
virtual dkCollection* listDataSources();
virtual DKString* listDataSourceNames(long& arrarySize);
virtual DKAny listServers();
virtual DKAny listSchema();
virtual DKAny listSchemaAttributes(const char* schemaEntry);
virtual DKString* listEntityNames(long& arraySize);
virtual dkCollection* listEntityAttrs(const char* entityName);
virtual DKString* listEntityAttrNames(const char* entityName, long& arraySize);
virtual dkDatastoreDef* datastoreDef();
virtual DKString registerMapping(DKNVPair* sourceMap);
virtual void unRegisterMapping(const char* mappingName);
virtual DKString* listMappingNames(long& arraySize);
virtual dkSchemaMapping* getMapping(const char* mappingName);
virtual dkExtension* getExtension(const char* extensionName);
virtual void addExtension(const char* extensionName, dkExtension* extensionObj);
virtual void removeExtension(const char* extensionName);
virtual DKString* listExtensionNames(long& arraySize);
virtual DKDDO* createDDO(const char* objectType, long Flags);
void changePassword(DKString userId, DKString oldPwd, DKString newPwd);
virtual DKCQExpr* translate(DKCQExpr* cqe);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.