KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DATABASE_SOURCE Struct Reference

#include <database_lib_settings.h>

Public Member Functions

DATABASE_SOURCE Expanded (const wxString &aBaseDir) const
 
std::string Describe () const
 

Public Attributes

DATABASE_SOURCE_TYPE type = DATABASE_SOURCE_TYPE::ODBC
 
std::string dsn
 
std::string username
 
std::string password
 
int timeout = 0
 
std::string connection_string
 
std::string path
 Database file of a SQLITE or ACCESS source.
 
std::string type_name
 Raw source.type as written, kept for the error when the type is INVALID.
 

Detailed Description

Definition at line 42 of file database_lib_settings.h.

Member Function Documentation

◆ Describe()

std::string DATABASE_SOURCE::Describe ( ) const
Returns
the database file of a SQLITE or ACCESS source, the DSN of an ODBC one, or for a connection string its driver and database file or name. Never the password, so it is safe for error messages and traces. Empty when there is nothing safe to show, in which case callers supply their own wording.

Definition at line 191 of file database_lib_settings.cpp.

References ACCESS, connection_string, dsn, find, holdsAssignment(), parseConnectionString(), path, SQLITE, and type.

◆ Expanded()

DATABASE_SOURCE DATABASE_SOURCE::Expanded ( const wxString & aBaseDir) const
Returns
a copy with ${CWD} replaced by aBaseDir in the connection string and the path

Definition at line 177 of file database_lib_settings.cpp.

References connection_string, and path.

Referenced by DATABASE_BACKEND::Create().

Member Data Documentation

◆ connection_string

std::string DATABASE_SOURCE::connection_string

◆ dsn

std::string DATABASE_SOURCE::dsn

◆ password

std::string DATABASE_SOURCE::password

Definition at line 47 of file database_lib_settings.h.

Referenced by ResolveDatabasePassword().

◆ path

std::string DATABASE_SOURCE::path

Database file of a SQLITE or ACCESS source.

Definition at line 50 of file database_lib_settings.h.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::chooseSavePath(), Describe(), describeFailure(), and Expanded().

◆ timeout

int DATABASE_SOURCE::timeout = 0

Definition at line 48 of file database_lib_settings.h.

Referenced by describeFailure().

◆ type

Definition at line 44 of file database_lib_settings.h.

Referenced by Describe(), describeFailure(), and hasKeyringLogin().

◆ type_name

std::string DATABASE_SOURCE::type_name

Raw source.type as written, kept for the error when the type is INVALID.

Definition at line 51 of file database_lib_settings.h.

Referenced by describeFailure().

◆ username

std::string DATABASE_SOURCE::username

The documentation for this struct was generated from the following files: