summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbc/Connection.idl
blob: 63854aa4c514c3108c70c4f5045d43649cde3757 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* -*- 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 {

 published interface XConnection;
 published interface XWarningsSupplier;


/** represents a connection (session) with a specific
    database. Within the context of a Connection, SQL statements are
    executed and results are returned.

    <p>
    A Connection's database is able to provide information
    describing its tables, its supported SQL grammar, its stored
    procedures, and the capabilities of this connection. This
    information is obtained with the
    com::sun::star::sdbc::XConnection::getMetaData()
    method.
    </p>
    <p>
    <b>
    Note:
    </b>
    By default the Connection automatically commits
    changes after executing each statement. If auto commit has been
    disabled, an explicit commit must be done or database changes will
    not be saved.

    </p>
    @see com::sun::star::sdbc::XStatement
    @see com::sun::star::sdbc::XResultSet
    @see com::sun::star::sdbc::XDatabaseMetaData
 */
published service Connection
{

    /** controls the closing of a connection.
     */
    interface com::sun::star::lang::XComponent;


    /** the main interface for interaction with a connection to a database.
     */
    interface XConnection;


    /** controls the chaining of warnings, which may occur on every call
             to the connected database. Chained warnings from previous calls will be
             cleared before processing a new call.
     */
    interface XWarningsSupplier;
};


}; }; }; };

/*===========================================================================
===========================================================================*/

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */