Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: sdb ::

service DataSource

Description
is a factory to establish database connections. It should be registered at a NamingService.
See also
com::sun::star::sdb::DatabaseContext


Exported Interfaces

com::sun::star::beans::XPropertySet
Description
provides information about and access to the properties from an implementation.
com::sun::star::sdb::XCompletedConnection
Description
useful for establishing connections with the completion of connection parameters provided during user interaction.
com::sun::star::util::XFlushable
Description
is provided to flush a DataSource within to a Database Context.
com::sun::star::sdb::XQueryDefinitionsSupplier
Description
provides the access to DataSource related queries.

The object returned by the XQueryDefinitionsSupplier::getQueryDefinitions() supports the DefinitionContainer service.

com::sun::star::sdb::XBookmarksSupplier
[ OPTIONAL ]
Description
provides access to bookmarks to documents associated with the data source

The object returned by the XBookmarksSupplier::getBookmarks() supports the DefinitionContainer service.


Properties' Summary

Name is the name of the data source.
URL indicates a database url of the form
jdbc: subprotocol : subname or sdbc: subprotocol : subname
Info is a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included.
User determines a users login name.
Password determines a users password. The password is not persistent.
IsPasswordRequired indicates that a password is always necessary.
SuppressVersionColumns indicates that components displaying data obtained from this data source should suppress columns used for versioning.
IsReadOnly determines whether modifications on the data source are allowed or not.
NumberFormatsSupplier provides an object for formatting numbers.
TableFilter defines a list of tables, on which the DataSource should have it's focus. If empty, all tables are rejected.
TableTypeFilter defines a list of table types, on which the DataSource should have it's focus. If empty, all table types are rejected.

Properties' Details

Name
 
[ readonly ] string Name;
Description
is the name of the data source.
URL
 
string URL;
Description
indicates a database url of the form
jdbc: subprotocol : subname or sdbc: subprotocol : subname
Info
 
sequence< com::sun::star::beans::PropertyValue > Info;
Description
is a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included.
User
 
string User;
Description
determines a users login name.
Password
 
string Password;
Description
determines a users password. The password is not persistent.
IsPasswordRequired
 
boolean IsPasswordRequired;
Description
indicates that a password is always necessary.
SuppressVersionColumns
 
boolean SuppressVersionColumns;
Description
indicates that components displaying data obtained from this data source should suppress columns used for versioning.
IsReadOnly
 
[ readonly ] boolean IsReadOnly;
Description
determines whether modifications on the data source are allowed or not.
NumberFormatsSupplier
 
[ readonly ] com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier;
Description
provides an object for formatting numbers.
TableFilter
 
sequence< string > TableFilter;
Description
defines a list of tables, on which the DataSource should have it's focus. If empty, all tables are rejected.
TableTypeFilter
 
sequence< string > TableTypeFilter;
Description
defines a list of table types, on which the DataSource should have it's focus. If empty, all table types are rejected.

Top of Page