dbmetadata.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#ifndef INCLUDED_CONNECTIVITY_DBMETADATA_HXX
#define INCLUDED_CONNECTIVITY_DBMETADATA_HXX
 
#include <com/sun/star/uno/Reference.hxx>
 
#include <memory>
#include <connectivity/dbtoolsdllapi.hxx>
 
namespace com::sun::star::sdbc { class XConnection; }
namespace com::sun::star::uno { class XComponentContext; }
 
namespace dbtools
{
 
 
    //= DatabaseMetaData
 
    struct DatabaseMetaData_Impl;
    class OOO_DLLPUBLIC_DBTOOLS DatabaseMetaData
    {
    private:
        ::std::unique_ptr< DatabaseMetaData_Impl >    m_pImpl;
 
    public:
        DatabaseMetaData();
        DatabaseMetaData(
            const css::uno::Reference< css::sdbc::XConnection >& _connection );
        DatabaseMetaData( const DatabaseMetaData& _copyFrom );
        DatabaseMetaData& operator=( const DatabaseMetaData& _copyFrom );
        DatabaseMetaData(DatabaseMetaData&& _copyFrom) noexcept;
        DatabaseMetaData& operator=(DatabaseMetaData&& _copyFrom) noexcept;
 
        ~DatabaseMetaData();
 
    public:
        bool    isConnected() const;
 
        void    reset( const css::uno::Reference< css::sdbc::XConnection >& _connection )
        {
            *this = DatabaseMetaData( _connection );
        }
 
        const OUString&  getIdentifierQuoteString() const;
 
        const OUString&  getCatalogSeparator() const;
 
        bool supportsSubqueriesInFrom() const;
 
        bool supportsPrimaryKeys() const;
 
        bool restrictIdentifiersToSQL92() const;
 
        bool generateASBeforeCorrelationName() const;
 
        bool shouldEscapeDateTime() const;
 
        bool shouldSubstituteParameterNames() const;
 
        bool isAutoIncrementPrimaryKey() const;
 
        sal_Int32
            getBooleanComparisonMode() const;
 
        bool supportsRelations() const;
 
        bool supportsColumnAliasInOrderBy() const;
 
        bool    supportsUserAdministration( const css::uno::Reference<css::uno::XComponentContext>& _rContext ) const;
 
        bool displayEmptyTableFolders() const;
 
        bool supportsThreads() const;
    };
 
 
} // namespace dbtools
 
 
#endif // INCLUDED_CONNECTIVITY_DBMETADATA_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */