get (Database Toolbox User's Guide)

get	Examples See Also

Get property of database connection or cursor structure

Syntax

value = get(conn, 'propertyname')
value = get(cursor, 'propertyname')
value = conn.propertyname
value = cursor.propertyname

Description

value = get(conn, 'propertyname')

gets the value of propertyname for the database connection, conn.

Allowable property names and returned values for conn are


`autocommit`	status of the `autocommit` flag, either `on` or `off`, as specified by `set`
`driver`	driver used for the JDBC connection, as specified by `database`
`handle`	identifying number for the connection
`instance`	name of the data source for an ODBC connection or the database for a JDBC connection, as specified by `database`
`message`	error message returned by `database`
`URL`	for a JDBC connection only, the JDBC URL structure, `jdbc:subprotocol:subname`, as specified by `database`
`username`	user name required to connect to the database, as specified by `database`; note that you cannot use `get` to retrieve `password`

value = get(cursor, 'propertyname')

gets the value of propertyname for the cursor structure, cursor.

Allowable property names and values for cursor are:


`attributes`	cursor attributes
`data`	data in the cursor structure data element
`message`	error message returned from `exec` or `fetch`
`rowlimit`	maximum number of rows to be returned by `fetch`, as specified by `set`
`sqlquery`	SQL statement for the cursor, as specified by `exec`

value = conn.propertyname

gets the value for the specified connection propertyname.

value = cursor.propertyname

gets the value for the specified cursor propertyname.

For command line help on get, use the overloaded methods:

help cursor/get.m
help database/get.m

Examples

Example 1 - Get connection property, data source name

Connect to the database, SampleDB. Then get the name of the data source for the connection and assign it to AA:

connA = database('SampleDB', '', '');
AA = get(connA, 'instance')

MATLAB returns:

AA =
SampleDB

Example 2 - Get a connection property, autocommit flag status

Determine the status of the autocommit flag for connA:

get(connA, 'autocommit')

ans =
on

Example 3 - Display data in cursor

Display the data in cursorA:

get(cursorA, 'data')

or type:

cursorA.data

MATLAB returns:

ans = 
    'Germany'
    'Mexico'
    'France'
    'Canada'

cursorA contains one column with four records.