Created
June 7, 2018 23:34
-
-
Save mbency/c0d608f0e69876334bfb00746968192b to your computer and use it in GitHub Desktop.
coldfusion11_admin_api_datasource.cfc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| CFIDE.adminapi.datasource | |
| Component datasource (datasource) | |
| Add, modify, and delete ColdFusion data sources. | |
| hierarchy: WEB-INF.cftags.component | |
| CFIDE.adminapi.base | |
| CFIDE.adminapi.datasource | |
| serializable: Yes | |
| properties: | |
| methods: checkAllowedFileExtensions, deleteDatasource, formatJdbcURL*, getAccessDefaultsFromRegistry*, getCFSettingDefaults*, getDatasourceDefaults*, getDatasources, getDriverDefaults*, getDriverDetails, getNewDSNDefaults*, getODBCDatasources, getSlsAgentServiceName*, getSlsServerPath*, getSlsServerServiceName*, getURLDefaults*, installOdbcService, removeOdbcService, setDB2, setDerbyClient, setDerbyEmbedded, setInformix, setJNDI, setMSAccess, setMSAccessUnicode, setMSSQL, setMySQL5, setMySQL_DD, setODBCSocket, setOracle, setOther, setPostGreSQL, setSlsServerServiceName*, setSybase, sl54Add*, sl54Del*, sl54displ*, sl54mlog*, sl54mod*, startOdbcService, stopOdbcService, updateODBCServerDSN*, upgradeOdbcService*, verifyDsn | |
| inherited methods: dump, getEdition, getInstallType, isAdminUser, logaudit | |
| * - private method | |
| checkAllowedFileExtensions | |
| public any checkAllowedFileExtensions ( required string ext ) | |
| Checks if extension is allowed or not. | |
| Output: suppressed | |
| Parameters: | |
| ext: string, required, ext | |
| deleteDatasource | |
| public void deleteDatasource ( required dsnname ) | |
| Deletes the specified data source. | |
| Output: suppressed | |
| Parameters: | |
| dsnname: any, required, dsnname - The name of the data source to be deleted. | |
| formatJdbcURL* | |
| private formatJdbcURL ( required driver, host, port, dsn, database, datasource, args, informixServer, selectMethod, SID, MaxPooledStatements, isnewdb, qTimeout, applicationintent ) | |
| Formats the JDBC URL. | |
| Output: suppressed | |
| Parameters: | |
| driver: any, required, driver - JDBC driver. | |
| host: any, optional, host - Machine to connect to. | |
| port: any, optional, port - Port number on which the server is listening. | |
| dsn: any, optional, dsn - Name that ColdFusion uses to connect to the data source. | |
| database: any, optional, database - Name of database to access. | |
| datasource: any, optional, datasource - Actual name of data source. | |
| args: any, optional, args - Semicolon-separated list of arguments. | |
| informixServer: any, optional, informixServer - Informix server name. | |
| selectMethod: any, optional, selectMethod - Name of method for SELECT statement. | |
| SID: any, optional, SID - Database system ID name. | |
| MaxPooledStatements: any, optional, MaxPooledStatements - Maximum number of database statements to pool. | |
| isnewdb: any, optional, isnewdb | |
| qTimeout: any, optional, qTimeout - Query timeout value for all the statements created by the connection. | |
| applicationintent: any, optional, applicationintent - Query timeout value for all the statements created by the connection. | |
| getAccessDefaultsFromRegistry* | |
| private getAccessDefaultsFromRegistry ( required scope, required dsn ) | |
| Retrieves Microsoft Access default values from Windows registry. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Arguments scope to receive default values. | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| getCFSettingDefaults* | |
| private getCFSettingDefaults ( required scope ) | |
| Gets the cfsetting defaults to the arguments scope that is passed. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.) | |
| getDatasourceDefaults* | |
| private getDatasourceDefaults ( required scope, required dsn ) | |
| Gets the DSN defaults to the arguments scope that is passed in. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.) | |
| dsn: any, required, dsn - Data source name. | |
| getDatasources | |
| public any getDatasources ( dsnname ) | |
| Returns a structure containing all data sources or a specified data source. | |
| Output: suppressed | |
| Parameters: | |
| dsnname: any, optional, dsnname - The name of the data source for which a structure is returned. | |
| getDriverDefaults* | |
| private getDriverDefaults ( required scope ) | |
| Gets the driver defaults to the arguments scope that is passed in. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Scope - any structure (user-defined, form, URL, etc.) | |
| getDriverDetails | |
| public struct getDriverDetails ( String driverName="" ) | |
| Returns a structure containing all drivers | |
| Output: suppressed | |
| Parameters: | |
| driverName: String, optional, driverName - Name of the driver, if this is passed details of only that driver is returned | |
| getNewDSNDefaults* | |
| private getNewDSNDefaults ( required scope ) | |
| Gets the data source defaults to the arguments scope that is passed in. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Scope - Any structure (user-defined, form, URL, etc.) | |
| getODBCDatasources | |
| public any getODBCDatasources ( ) | |
| Returns a query object that contains one row for each ODBC data source. | |
| Output: suppressed | |
| getSlsAgentServiceName* | |
| private String getSlsAgentServiceName ( ) | |
| Returns the name of the ODBC server agent. | |
| Output: suppressed | |
| getSlsServerPath* | |
| private String getSlsServerPath ( ) | |
| Returns the path/filename of the ODBC Sequelink INI file. | |
| Output: suppressed | |
| getSlsServerServiceName* | |
| private String getSlsServerServiceName ( ) | |
| Returns the ODBC Server service name. | |
| Output: suppressed | |
| getURLDefaults* | |
| private getURLDefaults ( required scope, driver="", required delims ) | |
| Returns URL default values. | |
| Output: suppressed | |
| Parameters: | |
| scope: any, required, scope - Arguments scope to receive URL default values. | |
| driver: any, optional, driver - Driver name, | |
| delims: any, required, delims - Delimiters. | |
| installOdbcService | |
| public void installOdbcService ( ) | |
| Installs ODBC service. | |
| Output: suppressed | |
| removeOdbcService | |
| public void removeOdbcService ( ) | |
| Removes ODBC service. | |
| Output: suppressed | |
| setDB2 | |
| public void setDB2 ( required string name, required string host, required string database, string originaldsn="", string port="50000", string driver="DB2", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string initargs="", string args="", numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, string vendor="db2", string type="ddtek", string validationQuery="", numeric qTimeout, boolean delete, boolean useSpyLog, string spyLogFile, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a DB2 data source. Refer to the ColdFusion documentation or ColdFusion Administrator online Help for a list of supported DB2 versions. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion data source name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Name of database on the server. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). | |
| port: string, optional, port - Port used to access the database server. The default is 50000. | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - Fully qualified JDBC driver class name. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Data source description. | |
| initargs: string, optional, initargs - Initialization connection string arguments, formatted (arg1=arg1value;arg2=arg2value). | |
| args: string, optional, args - Connection string arguments, formatted (arg1=arg1value;arg2=arg2value). | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. | |
| maxconnections: numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for the data source. | |
| disable: boolean, optional, disable - Disable connections to data sources. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| vendor: string, optional, vendor - Always DB2. | |
| type: string, optional, type - Always ddtek. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setDerbyClient | |
| public void setDerbyClient ( required string name, required string host, required string database, string originaldsn="", string driver="Apache Derby Client", string class="org.apache.derby.jdbc.ClientDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", string port="1527", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies an Apache Derby Client data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| port: string, optional, port | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setDerbyEmbedded | |
| public void setDerbyEmbedded ( required string name, required string database, string originaldsn="", string driver="Apache Derby Embedded", string class="org.apache.derby.jdbc.EmbeddedDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, boolean isnewdb="false", numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, numeric maxpooledstatements, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies an Apache Derby Embedded data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| database: string, required, database - Fully qualified path to the folder containing the Derby database. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| isnewdb: boolean, optional, isnewdb - Indicates whether the database needs to be created | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| maxpooledstatements: numeric, optional, maxpooledstatements - Maximum number of pooled statements. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setInformix | |
| public void setInformix ( string vendor="informix", string type="ddtek", required string name, required string host, required string database, required string InformixServer, string originaldsn="", string port="1526", string driver="Informix", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", numeric qTimeout, boolean useSpyLog, string spyLogFile, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies an Informix data source. | |
| Output: suppressed | |
| Parameters: | |
| vendor: string, optional, vendor - Always Informix. | |
| type: string, optional, type - Always ddtek. | |
| name: string, required, name - ColdFusion data source name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Name of database on the server. | |
| InformixServer: string, required, InformixServer - Name of the Informix server that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). | |
| port: string, optional, port - Port used to access the database server. The default is 1526. | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC driver class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Data source description. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. | |
| maxconnections: numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for the data source. | |
| disable: boolean, optional, disable - Disable connections to data sources. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setJNDI | |
| public void setJNDI ( required string name, required string jndiname, string driver="jndi", string type="j2ee", string originaldsn="", string username="", string password="", boolean encryptpassword="true", string description="", string jndienv="", numeric buffer, numeric blob_buffer, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete ) | |
| Creates a ColdFusion datasource that points to an already exsiting JNDI datasource | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| jndiname: string, required, jndiname - URL of the JNDI datasource | |
| driver: string, optional, driver | |
| type: string, optional, type - J2EE datasource | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Description of this data source connection. | |
| jndienv: string, optional, jndienv - JNDI environment settings | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| setMSAccess | |
| public void setMSAccess ( required string name, required string databasefile, string originaldsn="", string driver="MSAccess", string class="macromedia.jdbc.MacromediaDriver", string port="20004", string username="System", string password="", boolean encryptpassword="true", string description="", string args, string systemDatabaseFile, boolean UseTrustedConnection="true", string defaultusername="", numeric maxBufferSize, numeric pageTimeout="600", boolean TimeStampAsString="no", numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", string defaultpassword="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a Microsoft Access data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion data source name. | |
| databasefile: string, required, databasefile - Fully qualified path to the file containing the Access MDB file. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion data source name (use if you are renaming this data source). | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - Fully qualified JDBC driver class name. | |
| port: string, optional, port - Port used to access the database server. The default is 20004. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Data source description. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=arg1value;arg2=arg2value). | |
| systemDatabaseFile: string, optional, systemDatabaseFile - For secure access to the database file, specify the fully qualified path name of the database that contains database security information. The system database is usually located in winnt\system32\system.mdw. | |
| UseTrustedConnection: boolean, optional, UseTrustedConnection - If selected, causes ODBC driver to use the credentials specified in the ODBC connection or the network login id. | |
| defaultusername: string, optional, defaultusername - The user name that the driver uses to connect to the data source if an application requests a connection without supplying a user name. | |
| maxBufferSize: numeric, optional, maxBufferSize - The total number of bytes that ColdFusion uses to cache application pages. Enter a value to optimize ColdFusion performance. | |
| pageTimeout: numeric, optional, pageTimeout - The number of milliseconds before a request for a ColdFusion page times out. The default is 600. If you observe excessive network activity when using this driver, increase the page timeout value. | |
| TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Limit the number of data source connections to the value specified in the maxconnections argument. | |
| maxconnections: numeric, optional, maxconnections - The maximum number of data source connections; used if you specify True for the enablemaxconnections argument. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for the data source. | |
| disable: boolean, optional, disable - Disable connections to data sources. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| defaultpassword: string, optional, defaultpassword - The password that the driver uses to connect to the data source if an application requests a connection without supplying a user name. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setMSAccessUnicode | |
| public void setMSAccessUnicode ( required string name, required string databasefile, string originaldsn="", string driver="MSAccessJet", string class="com.inzoom.jdbcado.Driver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric pageTimeout="600", numeric maxBufferSize, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a Microsoft Access Unicode data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| databasefile: string, required, databasefile - database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Data source description. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| pageTimeout: numeric, optional, pageTimeout - The number of milliseconds before a request for a ColdFusion page times out. The default is 600. If you observe excessive network activity when using this driver, increase the page timeout value. | |
| maxBufferSize: numeric, optional, maxBufferSize - The total number of bytes that ColdFusion uses to cache application pages. Enter a value to optimize ColdFusion performance. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setMSSQL | |
| public void setMSSQL ( string vendor="sqlserver", string type="ddtek", required string name, required string host, required string database, string originaldsn="", string port="1433", string driver="MSSQLServer", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, boolean sendStringParametersAsUnicode, required string selectmethod="cursor", numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", numeric qTimeout, string applicationintent="readwrite", boolean useSpyLog, string spyLogFile, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a Microsoft SQL Server data source. | |
| Output: suppressed | |
| Parameters: | |
| vendor: string, optional, vendor - Always Microsoft. | |
| type: string, optional, type - Always ddtek. | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 1433) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description for this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| sendStringParametersAsUnicode: boolean, optional, sendStringParametersAsUnicode - Enable Unicode for data sources configured for non-Latin characters | |
| selectmethod: string, required, selectmethod - Select Method (direct or cursor) | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| applicationintent: string, optional, applicationintent - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setMySQL5 | |
| public void setMySQL5 ( required string name, required string host, required string database, string originaldsn="", string port="3306", string driver="MySQL5", string class="com.mysql.jdbc.Driver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a MySQL 4 or MySQL 5 data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 3306) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setMySQL_DD | |
| public void setMySQL_DD ( required string name, required string host, required string database, string originaldsn="", string port="3306", string driver="MySQL_DD", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, numeric maxpooledstatements, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", numeric qTimeout, boolean useSpyLog, string spyLogFile, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a MySQL 5 datasource using drivers provided by DataDirect. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 3306) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| maxpooledstatements: numeric, optional, maxpooledstatements - Maximum number of pooled statements. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setODBCSocket | |
| public void setODBCSocket ( required string name, required string datasource, string useTrustedConnection, string username="", string password="", boolean encryptpassword="true", string host="localhost", string originaldsn="", string port="20004", string driver="ODBCSocket", string class="macromedia.jdbc.MacromediaDriver", string description="", string args, boolean TimeStampAsString="no", numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies an ODBC socket data source. | |
| Output: enabled | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| datasource: string, required, datasource - name of ODBC datasource, defined in the server control panel. | |
| useTrustedConnection: string, optional, useTrustedConnection - If selected, causes ODBC driver to use the credentials specified in the ODBC connection or the network login id. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| host: string, optional, host - Database server host name or IP address. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 20004) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setOracle | |
| public void setOracle ( string vendor="oracle", string type="ddtek", required string name, required string host, required string sid, string originaldsn="", string port="1521", string driver="Oracle", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", numeric qTimeout, boolean useSpyLog, string spyLogFile, boolean supportLinks, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies an Oracle data source. | |
| Output: suppressed | |
| Parameters: | |
| vendor: string, optional, vendor - Always Oracle. | |
| type: string, optional, type - Always ddtek. | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| sid: string, required, sid - The Oracle System Identifier that refers to the instance of the Oracle database software running on the server. ORCL is the default. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 1521) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| supportLinks: boolean, optional, supportLinks - Enables Oracle Linked Servers support | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setOther | |
| public void setOther ( required string name, required string url, required string class, string driver, string originaldsn="", string port="1433", string username="", string password="", boolean encryptpassword="true", string description="", string args, required string selectmethod="cursor", numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling="false", boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a user-defined data source | |
| Output: enabled | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| url: string, required, url - The JDBC Connection URL for this data source. | |
| class: string, required, class - JDBC class file. | |
| driver: string, optional, driver - JDBC driver. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - port that is used to access the database server. (default 1433) | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| selectmethod: string, required, selectmethod - Select Method (direct or cursor). | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setPostGreSQL | |
| public void setPostGreSQL ( required string name, required string host, required string database, string originaldsn="", string port="5432", string driver="PostgreSQL", string class="org.postgresql.Driver", string username="", string password="", boolean encryptpassword="true", string description="", string args, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a PostGreSQL data source. | |
| Output: suppressed | |
| Parameters: | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 5432) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-datasource.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - A description for this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| setSlsServerServiceName* | |
| private String setSlsServerServiceName ( required serviceName ) | |
| Adds a new SequeLink service name | |
| Output: suppressed | |
| Parameters: | |
| serviceName: any, required, serviceName - SequeLink service name | |
| setSybase | |
| public void setSybase ( string vendor="sybase", string type="ddtek", required string name, required string host, required string database, string originaldsn="", string port="5000", string driver="Sybase", string class="macromedia.jdbc.MacromediaDriver", string username="", string password="", boolean encryptpassword="true", string description="", string args, string selectmethod="direct", numeric MaxPooledStatements, numeric timeout, numeric interval, numeric login_timeout, numeric buffer, numeric blob_buffer, boolean enablemaxconnections, numeric maxconnections, boolean pooling, boolean disable, boolean disable_clob, boolean disable_blob, boolean disable_autogenkeys, boolean select, boolean create, boolean grant, boolean insert, boolean drop, boolean revoke, boolean update, boolean alter, boolean storedproc, boolean delete, string validationQuery="", numeric qTimeout, boolean useSpyLog, string spyLogFile, boolean validateConnection, boolean clientHostName, boolean clientuser, boolean applicationName, string applicationNamePrefix ) | |
| Creates or modifies a Sybase data source. | |
| Output: suppressed | |
| Parameters: | |
| vendor: string, optional, vendor - Always Sybase. | |
| type: string, optional, type - Always ddtek. | |
| name: string, required, name - ColdFusion datasource name. | |
| host: string, required, host - Database server host name or IP address. | |
| database: string, required, database - Database name that corresponds to the data source. | |
| originaldsn: string, optional, originaldsn - Original ColdFusion datasource name, if you are renaming this dsn. | |
| port: string, optional, port - Port that is used to access the database server. (default 5000) | |
| driver: string, optional, driver - JDBC driver. | |
| class: string, optional, class - JDBC class file. | |
| username: string, optional, username - Database username. | |
| password: string, optional, password - Database password. | |
| encryptpassword: boolean, optional, encryptpassword - Indicates whether to encrypt the password when storing it in the neo-query.xml file: | |
| True – Encrypt the password before storing it. | |
| False - Store the password in clear text. | |
| Note: If you are updating a data source that already has an encrypted password, you must set this argument to false to avoid re-encrypting an encrypted password. | |
| description: string, optional, description - Description of this data source connection. | |
| args: string, optional, args - Connection string arguments, formatted (arg1=argvalue;arg2=argvalue). | |
| selectmethod: string, optional, selectmethod - Select Method (direct or cursor). | |
| MaxPooledStatements: numeric, optional, MaxPooledStatements - The maximum number of pooled statements. | |
| timeout: numeric, optional, timeout - The number of seconds that ColdFusion maintains an unused connection before destroying it. | |
| interval: numeric, optional, interval - The time (in seconds) that the server waits between cycles to check for expired data source connections to close. | |
| login_timeout: numeric, optional, login_timeout - The number of seconds before ColdFusion times out the data source connection login attempt. | |
| buffer: numeric, optional, buffer - The default buffer size, used if disable_clob is not specified or True. Default is 64000 bytes. | |
| blob_buffer: numeric, optional, blob_buffer - The default buffer size, used if disable_blob is not specified or True. Default is 64000 bytes. | |
| enablemaxconnections: boolean, optional, enablemaxconnections - Enables the maxconnections setting. | |
| maxconnections: numeric, optional, maxconnections - Limit connections to this maximum amount. | |
| pooling: boolean, optional, pooling - Enable server connection pooling for your data source. | |
| disable: boolean, optional, disable - Suspends all client connections to the data source. | |
| disable_clob: boolean, optional, disable_clob - Specify False to return the entire contents of any CLOB/Text columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the buffer argument. | |
| disable_blob: boolean, optional, disable_blob - Specify False to return the entire contents of any BLOB/Image columns in the database. If you specify False, ColdFusion retrieves up to the amount specified in the blob_buffer setting. | |
| disable_autogenkeys: boolean, optional, disable_autogenkeys - Specify true to disable retrieval of autogenerated keys | |
| select: boolean, optional, select - Allow SQL SELECT statements. | |
| create: boolean, optional, create - Allow SQL CREATE statements. | |
| grant: boolean, optional, grant - Allow SQL GRANT statements. | |
| insert: boolean, optional, insert - Allow SQL INSERT statements. | |
| drop: boolean, optional, drop - Allow SQL DROP statements. | |
| revoke: boolean, optional, revoke - Allow SQL REVOKE statements. | |
| update: boolean, optional, update - Allow SQL UPDATE statements. | |
| alter: boolean, optional, alter - Allow SQL ALTER statements. | |
| storedproc: boolean, optional, storedproc - Allow SQL stored procedure calls. | |
| delete: boolean, optional, delete - Allow SQL DELETE statements. | |
| validationQuery: string, optional, validationQuery - Validation Query used by Coldfusion for validating the connection state when removing connections from the connection pool. | |
| qTimeout: numeric, optional, qTimeout - Sets the default query timeout for statements created by a connection. Default is 0 which means that the query doesnt timeout. | |
| useSpyLog: boolean, optional, useSpyLog - Specify true to log the activity with this datasource | |
| spyLogFile: string, optional, spyLogFile - Sets the log file for this datasource | |
| validateConnection: boolean, optional, validateConnection - Should the connection be validated before using from pool. If JDBC 4.0 is being used, isValid() api will be called else Validation Query if specified will be called. | |
| clientHostName: boolean, optional, clientHostName - If client host name client info should be set before using connection. | |
| clientuser: boolean, optional, clientuser - If client user name client info should be set before using connection. | |
| applicationName: boolean, optional, applicationName - If application name client info should be set before using connection. | |
| applicationNamePrefix: string, optional, applicationNamePrefix - Prefix to use for application name, if application name is checked. | |
| sl54Add* | |
| private sl54Add ( required dsn, required odbcdsn, connectString, boolean TimeStampAsString="no" ) | |
| Adds a datasource to the SequeLink configuration. | |
| Available only for users in one of the roles: admin | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. | |
| connectString: any, optional, connectString - Passes database-specific parameters, such as login credentials, to the data source. | |
| TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. | |
| sl54Del* | |
| private sl54Del ( required dsn ) | |
| Removes a data source from the SequeLink configuration. | |
| Available only for users in one of the roles: admin | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| sl54displ* | |
| private sl54displ ( required dsn ) | |
| Available only for users in one of the roles: admin | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn | |
| sl54mlog* | |
| private sl54mlog ( required odbcdsn, logonmethod="OSIntegrated" ) | |
| Modifies the DBMS logon for the data source to SequeLink configuration. | |
| Available only for users in one of the roles: admin | |
| Output: suppressed | |
| Parameters: | |
| odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. | |
| logonmethod: any, optional, logonmethod - When anonymous: OSIntegrated; when not anonymous DBMSLOGON(userid, password) | |
| sl54mod* | |
| private sl54mod ( required dsn, required odbcdsn, connectString, boolean TimeStampAsString="no" ) | |
| Modifies an ODBC data source connection string in the SequeLink configuration. | |
| Available only for users in one of the roles: admin | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| odbcdsn: any, required, odbcdsn - Name of the ODBC data source that ColdFusion is to connect to. | |
| connectString: any, optional, connectString - Passes database-specific parameters, such as login credentials, to the data source. | |
| TimeStampAsString: boolean, optional, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. | |
| startOdbcService | |
| public startOdbcService ( ) | |
| Starts ODBC service. | |
| Output: suppressed | |
| stopOdbcService | |
| public void stopOdbcService ( ) | |
| Stops ODBC service. | |
| Output: suppressed | |
| updateODBCServerDSN* | |
| private updateODBCServerDSN ( required dsn, required odbcdsn, required connectstring, required TimeStampAsString, required LOGONMETHOD ) | |
| Updates an ODBC server data source name. | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| odbcdsn: any, required, odbcdsn - The ODBC data source name to which ColdFusion is to connect. | |
| connectstring: any, required, connectstring - Passes database-specific parameters, such as login credentials, to the data source. | |
| TimeStampAsString: any, required, TimeStampAsString - Enable this setting if your application retrieves Date/Time data and then re-uses it in SQL statements without applying formatting (using functions such as DateFormat, TimeFormat, and CreateODBCDateTime). Specify True or False. | |
| LOGONMETHOD: any, required, LOGONMETHOD - Internal method called to the register the database. | |
| upgradeOdbcService* | |
| private upgradeOdbcService ( odbcserver="[runtime expression]", odbcagent="[runtime expression]" ) | |
| Upgrade ODBC service. | |
| Output: suppressed | |
| Parameters: | |
| odbcserver: any, optional, odbcserver - Name of ODBC server service. | |
| odbcagent: any, optional, odbcagent - Name of ODBC agent service. | |
| verifyDsn | |
| public Any verifyDsn ( required dsn, boolean returnMsgOnError="false" ) | |
| Verifies a given data source name. | |
| Output: suppressed | |
| Parameters: | |
| dsn: any, required, dsn - Name that ColdFusion uses to connect to the data source. | |
| returnMsgOnError: boolean, optional, returnMsgOnError - The function returns the error message on any error if this parameter is true | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment