Properties' Summary |
string
DataSourceName |
[ OPTIONAL ]
specifies the name of the datasource to access.
|
string
DatabaseLocation |
[ OPTIONAL ]
specifies the URL of the database file.
|
string
ConnectionResource |
[ OPTIONAL ]
specifies the database URL which locates a database driver.
|
sequence< ::com::sun::star::beans::PropertyValue >
ConnectionInfo |
[ OPTIONAL ]
specifies additional info to use when creating a connection from a ConnectionResource
|
::com::sun::star::sdbc::XConnection
ActiveConnection |
[ OPTIONAL ]
is a connection to use.
|
string
Command |
[ OPTIONAL ]
specifies the command to execute to retrieve a result set.
|
long
CommandType |
[ OPTIONAL ]
specifies the type of the command to be executed to retrieve a result set.
|
string
Filter |
[ OPTIONAL ]
specifies an additional filter to optionally use.
|
string
Order |
[ OPTIONAL ]
specifies an additional ORDER BY clause which should be applied on top of
the given #Command.
|
string
HavingClause |
[ OPTIONAL ]
specifies an additional HAVING clause which should be applied on top of
the given #Command.
|
string
GroupBy |
[ OPTIONAL ]
specifies an additional GROUP BY clause which should be applied on top of
the given #Command.
|
boolean
EscapeProcessing |
[ OPTIONAL ]
specifies if the #Command should be analyzed on the client side before sending it
to the database server.
|
::com::sun::star::sdbc::XResultSet
ResultSet |
[ OPTIONAL ]
specifies an already existent result set to use.
|
sequence< any >
Selection |
[ OPTIONAL ]
specifies a selection to confine the records in a result set.
|
boolean
BookmarkSelection |
[ OPTIONAL ]
specifies how to interpret #Selection
|
string
ColumnName |
[ OPTIONAL ]
specifies a column name.
|
::com::sun::star::beans::XPropertySet
Column |
[ OPTIONAL ]
specifies a column object
|
Properties' Details |
DataSourceName
string DataSourceName;
- Usage Restrictions
- optional
- Description
- specifies the name of the datasource to access.
This data source is usually used to create a Connection. If no DataSourceName is given
and the #DatabaseLocation and the #ConnectionResource are empty, then an #ActiveConnection
is required.
- See also
- DatabaseContext, ActiveConnection
|
|
DatabaseLocation
string DatabaseLocation;
- Usage Restrictions
- optional
- Description
- specifies the URL of the database file.
This database location is usually used to create a Connection. If no DatabaseLocation is given
and the #ConnectionResource is empty, then an #ActiveConnection is required.
- See also
- DatabaseContext, ActiveConnection
|
|
ConnectionResource
string ConnectionResource;
- Usage Restrictions
- optional
- Description
- specifies the database URL which locates a database driver.
This database URL is usually used to create a Connection. If no ConnectionResource is given,
then an #ActiveConnection is required.
- See also
- DatabaseContext, ActiveConnection
|
|
ConnectionInfo
sequence< ::com::sun::star::beans::PropertyValue > ConnectionInfo;
- Usage Restrictions
- optional
- Description
- specifies additional info to use when creating a connection from a
ConnectionResource
This member is evaluated only when ConnectionResource is used: In this case,
com::sun::star::sdbc::XDriverManager::getConnectionWithInfo() is used
to create a connection for the given connection resource, instead of
com::sun::star::sdbc::XDriverManager::getConnection().
If the sequence is empty, it is ignored.
|
|
ActiveConnection
::com::sun::star::sdbc::XConnection ActiveConnection;
- Usage Restrictions
- optional
- Description
- is a connection to use.
This object is guaranteed to be a com::sun::star::sdbc::Connection, but usually
it will be a Connection from the module com::sun::star::sdb.
Especially in the case where no #DataSourceName is given, but
#CommandType is CommandType::QUERY, the ActiveConnection needs
to fully support the Connection service, to actually retrieve the query specified by
#Command
If no ActiveConnection is given, then a #DataSourceName is required.
- See also
- DataSourceName
|
|
Command
string Command;
- Usage Restrictions
- optional
- Description
- specifies the command to execute to retrieve a result set.
This property is only meaningful together with the #CommandType
property, thus either both or none of them are present.
- See also
- CommandType
|
|
CommandType
long CommandType;
- Usage Restrictions
- optional
- Description
- specifies the type of the command to be executed to retrieve a result set.
#Command needs to be interpreted depending on the value of this property.
This property is only meaningful together with the #Command
property, thus either both or none of them are present.
- See also
- CommandType
|
|
Filter
string Filter;
- Usage Restrictions
- optional
- Description
- specifies an additional filter to optionally use.
The Filter string has to form a WHERE -clause, without the
WHERE -string itself.
If a #DataSourceName, #Command and #CommandType
are specified, a RowSet can be created with this information. If the results provided by the
row set are to be additionally filtered, the Filter property can be used.
Note that the Filter property does not make sense if a #ResultSet has been specified
in the DataAccessDescriptor.
- See also
- RowSet, ResultSet
|
|
Order
string Order;
- Usage Restrictions
- optional
- Description
- specifies an additional
ORDER BY clause which should be applied on top of
the given #Command.
The keyword ORDER BY itself is not part of this property.
|
|
HavingClause
string HavingClause;
- Usage Restrictions
- optional
- Description
- specifies an additional
HAVING clause which should be applied on top of
the given #Command.
The keyword HAVING itself is not part of this property.
|
|
GroupBy
string GroupBy;
- Usage Restrictions
- optional
- Description
- specifies an additional
GROUP BY clause which should be applied on top of
the given #Command.
The keyword GROUP BY itself is not part of this property.
|
|
EscapeProcessing
boolean EscapeProcessing;
- Usage Restrictions
- optional
- Description
- specifies if the #Command should be analyzed on the client side before sending it
to the database server.
The default value of this property is `TRUE`. By switching it to `FALSE`, you can pass
backend-specific SQL statements, which are not standard SQL, to your database.
This property is usually present together with the #Command and
#CommandType properties, and is evaluated if and only if #CommandType
equals CommandType::COMMAND.
|
|
ResultSet
::com::sun::star::sdbc::XResultSet ResultSet;
- Usage Restrictions
- optional
- Description
- specifies an already existent result set to use.
Usually, you use the properties #DataSourceName (alternatively
#ActiveConnection), #Command and #CommandType to specify
how to obtain a result set. However, in scenarios where the provider of a DataAccessDescriptor
has access to an already existent result set, it can pass it along for reusage. This is encouraged
to increase performance.
The object will at least support the com::sun::star::sdbc::ResultSet service.
Note that any superservices of com::sun::star::sdbc::ResultSet
are also allowed. Especially, this member can denote an instance of the
com::sun::star::sdb::RowSet, or an instance obtained
by calling com::sun::star::sdb::XResultSetAccess::createResultSet()
on such a com::sun::star::sdb::RowSet. This becomes important in
conjunction with the #Selection property.
- See also
- XResultSetAccess
|
|
Selection
sequence< any > Selection;
- Usage Restrictions
- optional
- Description
- specifies a selection to confine the records in a result set.
When you specify a result set either implicitly (#DataSourceName, #Command,
#CommandType) or explicitly (#ResultSet), the set of results can be
additionally refined with this property.
The single elements of the #Selection are either record numbers (see
com::sun::star::sdbc::XResultSet::getRow()), or bookmarks (see
com::sun::star::sdbcx::XRowLocate::getBookmark()).
It is up to the component which provides or requires a DataAccessDescriptor to specify which of the
two alternatives it expects. If it does not specify this, then the property
#BookmarkSelection becomes mandatory.
If the elements specify bookmarks, and a #ResultSet has been specified, then
this result set is required to support the com::sun::star::sdbcx::XRowLocate interface.
|
|
BookmarkSelection
boolean BookmarkSelection;
- Usage Restrictions
- optional
- Description
- specifies how to interpret #Selection
If present, #BookmarkSelection specifies the semantics of #Selection. If
not present, it's up to the implementing component to specify this semantics.
If `TRUE`, then the single elements of the array specified by #Selection are
bookmarks relative to the result set, if `FALSE`, they're record numbers.
- See also
- ::com::sun::star::sdbcx::XRowLocate, ::com::sun::star::sdbc::XResultSet, XResultSetAccess
|
|
ColumnName
string ColumnName;
- Usage Restrictions
- optional
- Description
- specifies a column name.
This property is usually used together with the #Command and
#CommandType properties.
- See also
- Column
|
|
Column
::com::sun::star::beans::XPropertySet Column;
- Usage Restrictions
- optional
- Description
- specifies a column object
For reasons of performance and saving resources, a supplier of an DataAccessDescriptor which is
used to describe a column object can pass this object directly, instead of specifying it only implicitly
with the #ColumnName property.
The object will at least support the com::sun::star::sdbcx::Column service, but more
often it will even be a Column from the com::sun::star::sdb module.
|
|
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.