database_connection.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2022 Jon Evans <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_DATABASE_CONNECTION_H
#define KICAD_DATABASE_CONNECTION_H
 
#include <any>
#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <vector>
 
#include <database/database_cache.h>
 
extern const char* const traceDatabase;
 
 
namespace nanodbc
{
    class connection;
}
 
 
class DATABASE_CONNECTION
{
public:
    static const long DEFAULT_TIMEOUT = 10;
 
    typedef std::map<std::string, std::any> ROW;

    enum class FAILURE
    {
        UNKNOWN,
        LOGIN,       
        UNREACHABLE, 
        TIMEOUT,     
        NO_DSN,      
        NO_DRIVER    
    };
 
    DATABASE_CONNECTION( const std::string& aDataSourceName, const std::string& aUsername,
                         const std::string& aPassword, int aTimeoutSeconds = DEFAULT_TIMEOUT,
                         bool aConnectNow = true );
 
    DATABASE_CONNECTION( const std::string& aConnectionString,
                         int aTimeoutSeconds = DEFAULT_TIMEOUT,
                         bool aConnectNow = true );
 
    ~DATABASE_CONNECTION();
 
    void SetCacheParams( int aMaxSize, int aMaxAge );
 
    bool Connect();
 
    bool Disconnect();
 
    bool IsConnected() const;

    bool CacheTableInfo( const std::string& aTable, const std::set<std::string>& aRequiredColumns,
                         const std::set<std::string>& aOptionalColumns = {} );

    bool SelectOne( const std::string& aTable, const std::pair<std::string, std::string>& aWhere,
                    ROW& aResult );

    bool SelectAll( const std::string& aTable, const std::string& aKey,
                    std::vector<ROW>& aResults );

    bool SelectSample( const std::string& aTable, size_t aMaxRows, std::vector<std::string>& aColumns,
                       std::vector<ROW>& aRows );

    bool GetTables( std::vector<std::string>& aTables );

    bool GetColumns( const std::string& aTable, std::vector<std::string>& aColumns );

    struct DATA_SOURCE
    {
        std::string name;
        std::string driver;
    };

    static std::vector<DATA_SOURCE> ListDataSourceDetails();

    static std::vector<std::string> ListDrivers();
 
    void ClearCache( const std::string& aTable )
    {
        if( m_cache )
            m_cache->Clear( aTable );
    }
 
    std::string GetLastError() const { return m_lastError; }

    std::string GetLastState() const { return m_lastState; }

    static FAILURE ClassifyFailure( const std::string& aState, const std::string& aMessage );
 
private:
    void init();
 
    bool getQuoteChar();

    std::string quoted( const std::string& aIdentifier ) const;

    std::string escapePattern( const std::string& aName ) const;
 
    std::string columnsFor( const std::string& aTable );

    bool selectAllAndCache( const std::string& aTable, const std::string& aKey );
 
    std::unique_ptr<nanodbc::connection> m_conn;
 
    std::string m_dsn;
    std::string m_user;
    std::string m_pass;
    std::string m_connectionString;
 
    std::string m_lastError;
    std::string m_lastState;
 
    std::map<std::string, std::string> m_tables;

    std::map<std::string, std::map<std::string, int>> m_columnCache;
 
    long m_timeout;
 
    char m_quoteChar;
 
    std::string m_patternEscape;
 
    mutable std::mutex m_queryMutex;
 
    typedef DATABASE_CACHE<std::map<std::string, ROW>> DB_CACHE_TYPE;
 
    std::unique_ptr<DB_CACHE_TYPE> m_cache;
};
 
#endif //KICAD_DATABASE_CONNECTION_H