Evridb: Difference between revisions
imported>Scott |
imported>Scott No edit summary |
||
Line 94: | Line 94: | ||
| Sub structure of additional arguments. This value must be a sting of exactly what is required in the database connection string. | | Sub structure of additional arguments. This value must be a sting of exactly what is required in the database connection string. | ||
|} | |} | ||
==Query Properties== | |||
{| border="1" cellpadding="5" cellspacing="0" style="margin-left:3em" | |||
|- | |||
|valign="top" | | |||
<tt>.sql_string</tt> | |||
| Returns the short "keyword" model type of the current model (or empty string if the model type has not been set). This keyword most often is linked to the PLS_Toolbox function that created the given model. This can be assigned to any model type listed in the | |||
|- | |||
|valign="top" | | |||
<tt>.return_type</tt> | |||
| [{'cell'} 'dso']Specify how to return data, as DSO or Cell array. | |||
|- | |||
|valign="top" | | |||
<tt>.use_column_names</tt> | |||
| ['yes' 'no'] If return type = DSO, try to use column names as variable names in the DSO or the first row if cell output. | |||
|- | |||
|valign="top" | | |||
<tt>.query_watibar</tt> | |||
| ['on' 'off' {'auto'}] Show a waitbar when parsing jdbc record sets, 'auto' is set to show if larger than 1000 records. | |||
|- | |||
|valign="top" | | |||
<tt>.null_as_nan</tt> | |||
| [{1} 0] Interpret null values in a numeric column as NaN. Set to 0 to help speed up query parsing. | |||
|} | |||
''' | |||
% sql_string : Stored SQL statement run if .execute is empty. | |||
% return_type : Specify how to return data, as DSO or Cell array. | |||
% use_column_names : If return type = DSO, try to use column names as | |||
% variable names in the DSO or the first row if cell | |||
% output. | |||
% query_watibar : ['on'|'off'|{'auto'}] Show a waitbar when parsing jdbc | |||
% record sets, 'auto' is set to show if larger than 1000 | |||
% records. | |||
% null_as_nan : [{1} | 0] Interpret null values in a numeric column as | |||
% NaN. Set to 0 to help speed up query parsing. |
Revision as of 16:21, 13 June 2013
Introduction
EVRIDB Objects provide connection and query capability for many types of databases. For MySQL, ODBC, and JavaDB databases EVRIDB objects work with no special preparations. For other databases a JDBC Driver will be necessary. The object can return a cell array of values (with a mix of datatypes) or a DataSet Object .
This object is not heavily maintained for all database types. For more
The general workflow of using a EVRIDB object:
- Set connection attributes.
- Test the connection.
- Run queries.
Connection Properties
.type |
Type of connection (e.g., 'access' 'mysql' mssql') Determines what driver is used. When set, default values will be added to .provider, .driver, and .driver_jar_file where appropriate.
Microsoft Windows Connection
JDBC Type Connections
Custom Connections
|
.location |
Folder containing database file (on local file system). |
.create |
Depending on type of database, create database is not already. |
.persistent |
Do not close connection object after creation or query, stored (in appdata 0). When calling multiple times this can help reduce time to return results. |
.driver |
Driver to be used for connection (these must be currently installed on the machine, use the ODBC Manager from Administrative Tools to view currently available drivers on a Windows machine. JDBC must have driver location in .driver_jar_file. |
.driver_jar_file |
JDBC driver jar file location. This is added to the dynamic class path in Matlab. |
.provider |
Only used by ADODB object so this will always be 'MSDASQL'. |
.use_authentication |
Use user authentication when making connection, must provide .username and .pw. |
.username |
User to connect as. |
.pw |
Password to connect as. |
.use_encryption |
Whether or not to use database encryption (derby). |
.encryption_hash |
Hash key for encryption. |
.server |
IP address for database (default location is 'localhost'). |
.dsn |
Data Source Name (set up on local computer using ODBC Manager from Administrative Tools). If the database connection remains static, this can be a simple way to manage the connection. See the "ODBC" topic in Windows help for more information on DSN. |
.port |
Connection port number. |
.arguments.name |
Sub structure of additional arguments. This value must be a sting of exactly what is required in the database connection string. |
.arguments.value |
Sub structure of additional arguments. This value must be a sting of exactly what is required in the database connection string. |
Query Properties
.sql_string |
Returns the short "keyword" model type of the current model (or empty string if the model type has not been set). This keyword most often is linked to the PLS_Toolbox function that created the given model. This can be assigned to any model type listed in the |
.return_type |
[{'cell'} 'dso']Specify how to return data, as DSO or Cell array. |
.use_column_names |
['yes' 'no'] If return type = DSO, try to use column names as variable names in the DSO or the first row if cell output. |
.query_watibar |
['on' 'off' {'auto'}] Show a waitbar when parsing jdbc record sets, 'auto' is set to show if larger than 1000 records. |
.null_as_nan |
[{1} 0] Interpret null values in a numeric column as NaN. Set to 0 to help speed up query parsing. |
% sql_string : Stored SQL statement run if .execute is empty.
% return_type : Specify how to return data, as DSO or Cell array.
% use_column_names : If return type = DSO, try to use column names as
% variable names in the DSO or the first row if cell
% output.
% query_watibar : ['on'|'off'|{'auto'}] Show a waitbar when parsing jdbc
% record sets, 'auto' is set to show if larger than 1000
% records.
% null_as_nan : [{1} | 0] Interpret null values in a numeric column as
% NaN. Set to 0 to help speed up query parsing.