sqlIfParams.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1992-2024 MAK Technologies, Inc
** All rights reserved.
*******************************************************************************/


#pragma once

#include "databaseParameters.h"
#include <vlutil/vlString.h>

//
// class DtSqlIfParameters:
//
// To make most ODBC interface calls, it is necessary to first allocation an SQL
// environment object.  This class allocates an environment, and uses
// DtSqlIfErrorHandler to process any errors.
//
class DT_DLL_VLDB DtSqlDatabaseParameters : public DtDatabaseParameters
{
public:
   // Default constructor
   DtSqlDatabaseParameters();
   // Destructor
   virtual ~DtSqlDatabaseParameters();

private:
   DtSqlDatabaseParameters(const DtSqlDatabaseParameters&);
   DtSqlDatabaseParameters& operator=(const DtSqlDatabaseParameters&);
public:

   // Set/Get the Driver command
   virtual const DtString& driver() const;

   // ! \brief Keywords

   // Set/Get the DSN keyword
   virtual const DtString& DSNKeyword() const;

   // Set/Get the Database keyword
   virtual const DtString& DBKeyword() const;

   // Set/Get the Server keyword
   virtual const DtString& serverKeyword() const;

   // Set/Get the User keyword
   virtual const DtString& userKeyword() const;

   // Set/Get the Password keyword
   virtual const DtString& passwordKeyword() const;


   // Set/Get the DSN name
   virtual void setDataSourceName( const DtString& cmd );
   virtual const DtString& dataSourceName() const;

   // Set/Get the Master DSN name
   virtual void setMasterDataSourceName( const DtString& cmd );
   virtual const DtString& masterDataSourceName() const;

   // Set/Get the Database name
   virtual void setDatabaseName( const DtString& cmd );
   virtual const DtString& databaseName() const;

   // Set/Get the "Original" Database name
   virtual void setOrigDBName( const DtString& cmd );
   virtual const DtString& origDBName() const;

   // Set/Get the Master Database name
   virtual void setMasterDatabaseName( const DtString& cmd );
   virtual const DtString& masterDatabaseName() const;

   // Set/Get the Server name
   virtual void setServerName( const DtString& cmd );
   virtual const DtString& serverName() const;

   // Set/Get the User ID
   virtual void setUserID( const DtString& cmd );
   virtual const DtString& userID() const;

   // Set/Get the Password string
   virtual void setPassword( const DtString& cmd );
   virtual const DtString& password() const;

   // Set/Get the Other arguments
   virtual void setOtherArgs( const DtString& cmd );
   virtual const DtString& otherArgs() const;

   // Set/Get the User-defined parameters string
   virtual void setUserParametersString( const DtString& cmd );
   virtual const DtString& userParametersString() const;

   // Set/Get the Map Datum string
   virtual void setMapDatumString( const DtString& cmd );
   virtual const DtString& mapDatumString() const;

   static void initValue( const DtString& srcStr, DtString& valStr );

protected:
   virtual void setDriver( const DtString& cmd );
   virtual void setDSNKeyword( const DtString& cmd );
   virtual void setDBKeyword( const DtString& cmd );
   virtual void setServerKeyword( const DtString& cmd );
   virtual void setUserKeyword( const DtString& cmd );
   virtual void setPasswdKeyword( const DtString& cmd );

   DtString myDriverName;
   DtString myDSNKeyword;
   DtString myDSNName;
   DtString myMasterDSNName;
   DtString myDBKeyword;
   DtString myDBName;
   DtString myOrigDBName;
   DtString myMasterDBName;
   DtString myServerKeyword;
   DtString myServerName;
   DtString myUserKeyword;
   DtString myUserID;
   DtString myPasswdKeyword;
   DtString myPasswd;
   DtString myOtherArgs;
   DtString myUsrParams;
   DtString myMapDatum;
};