Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: sdbc ::

unpublished service ODBCConnectionProperties
Usage Restrictions
not published
Description
represents the properties for a ODBC connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().

The properties for a connection contain additonal information about how to connect to a database and how to control the behavior of the resulting connection should be.

See also
XDriver, XDriverManager, ConnectionProperties

Included Services - Summary
ConnectionProperties
(referenced entity's summary:)
represents the properties for a connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
Properties' Summary
boolean
ParameterNameSubstitution
[ OPTIONAL ]
should the parameter '?' in prepared statement be substituated with an distinct name  
long
Timeout
[ OPTIONAL ]
the Timeout after which time a timeout should happen  
boolean
Silent
[ OPTIONAL ]
Silent - should the connection be silent. No user interaction while creating the connection.  
boolean
UseCatalog
[ OPTIONAL ]
should the driver should support a catalog.  
string
CharSet
[ OPTIONAL ]
specifies the encoding to use to translate the backend data  
boolean
IsAutoRetrievingEnabled
[ OPTIONAL ]
specifies if retrieving of auto generated values should be enabled or not. If true than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.  
string
AutoRetrievingStatement
[ OPTIONAL ]
specifies the statement which should be executed when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.  
Included Services - Details
ConnectionProperties
(referenced entity's summary:)
represents the properties for a connection (session) with a specific database. These properties can be used when calling the method XDriver::connect() or XDriverManager::getConnectionWithInfo().
Properties' Details
ParameterNameSubstitution
boolean ParameterNameSubstitution;
Usage Restrictions
optional
Description
should the parameter '?' in prepared statement be substituated with an distinct name
Timeout
long Timeout;
Usage Restrictions
optional
Description
the Timeout after which time a timeout should happen
Silent
boolean Silent;
Usage Restrictions
optional
Description
Silent - should the connection be silent. No user interaction while creating the connection.
UseCatalog
boolean UseCatalog;
Usage Restrictions
optional
Description
should the driver should support a catalog.
CharSet
string CharSet;
Usage Restrictions
optional
Description
specifies the encoding to use to translate the backend data

See the IANA character set list for a list of valid values.

IsAutoRetrievingEnabled
boolean IsAutoRetrievingEnabled;
Usage Restrictions
optional
Description
specifies if retrieving of auto generated values should be enabled or not. If true than the statement will support the XGeneratedResultSet (future concept) interface, otherwise not.
AutoRetrievingStatement
string AutoRetrievingStatement;
Usage Restrictions
optional
Description
specifies the statement which should be executed when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.