98 lines
4 KiB
Text
98 lines
4 KiB
Text
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
module com { module sun { module star { module sdbc {
|
|
|
|
/** represents the properties for a JDBC connection (session) with a specific
|
|
database. These properties can be used when calling the method
|
|
com::sun::star::sdbc::XDriver::connect() or
|
|
com::sun::star::sdbc::XDriverManager::getConnectionWithInfo().
|
|
|
|
<p>
|
|
The properties for a connection contain additional information about how to connect to a database and
|
|
how to control the behavior of the resulting connection should be.
|
|
|
|
</p>
|
|
@see com::sun::star::sdbc::XDriver
|
|
@see com::sun::star::sdbc::XDriverManager
|
|
@see com::sun::star::sdbc::ConnectionProperties
|
|
*/
|
|
service JDBCConnectionProperties
|
|
{
|
|
service com::sun::star::sdbc::ConnectionProperties;
|
|
|
|
/** which JDBC driver class should be loaded to create the connection.
|
|
|
|
@see com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClassPath
|
|
*/
|
|
[optional, property] string JavaDriverClass;
|
|
|
|
/** an optional class path to locate the
|
|
com::sun::star::sdbc::JDBCConnectionProperties::JavaDriverClass
|
|
|
|
<p>The class path is a list of zero or more internal (see the
|
|
com::sun::star::uri::ExternalUriReferenceTranslator
|
|
service) URI references, where any space characters
|
|
(<code>U+0020</code>) are ignored (and, in particular, separate adjacent
|
|
URI references). Any “vnd.sun.star.expand” URL references
|
|
in the list are expanded using the
|
|
com::sun::star::util::theMacroExpander
|
|
singleton.</p>
|
|
|
|
@since OOo 2.3
|
|
*/
|
|
[optional, property] string JavaDriverClassPath;
|
|
|
|
/** specifies a set of properties to pass to <code>java.lang.System.setProperty</code> before
|
|
loading the system's JDBC driver.
|
|
*/
|
|
[optional, property] sequence< ::com::sun::star::beans::NamedValue > SystemProperties;
|
|
|
|
/** 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.
|
|
*/
|
|
[optional, property] boolean IsAutoRetrievingEnabled;
|
|
|
|
/** specifies the statement which should be executed
|
|
when asking an "INSERT" statement for the XGeneratedResultSet (future concept) interface.
|
|
*/
|
|
[optional, property] string AutoRetrievingStatement;
|
|
|
|
/** specifies how the type info returned by com::sun::star::sdbc::XDatabaseMetaData::getTypeInfo() will be modified.
|
|
<p>The sequence contains an even amount of string values. Each pair describes
|
|
what should be searched for and what should be replaced if found.
|
|
<br>
|
|
The syntax is:
|
|
<p>
|
|
<ul>
|
|
<li>COLUMN(2) = -5</li>
|
|
<li>COLUMN(6) = PRECISION</li>
|
|
</ul>
|
|
</p>
|
|
COLUMN(X) defines the column which will be compared and the column which will be replaced. In the example above column 2 will be compared
|
|
with the value -5. If this is true than column 6 will now return the value PRECISION.
|
|
</p>
|
|
*/
|
|
[optional, property] sequence< any > TypeInfoSettings;
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|