Modules/EDMIAPI/bin/Debug/DigitalData.Modules.Database.xml
2025-09-19 13:06:44 +02:00

336 lines
15 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Database
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Database.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Database.My.Resources.Resources.ResourceManager">
<summary>
Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
</summary>
</member>
<member name="P:DigitalData.Modules.Database.My.Resources.Resources.Culture">
<summary>
Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
</summary>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.Create(DigitalData.Modules.Logging.LogConfig,System.String)">
<summary>
Create a new instance of Dispatcher. This is the preferred way to create the dispatcher.
</summary>
<param name="pLogConfig">An instance of LogConfig</param>
<param name="pConnectionString">Initial connectionstring for connecting to DD_ECM database.</param>
<returns>An instance of Dispatcher with connections</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.#ctor(DigitalData.Modules.Logging.LogConfig,System.Collections.Generic.List{DigitalData.Modules.Database.Dispatcher.DispatcherConnection})">
<summary>
Create a new instance of Dispatcher. Needs a manually constructed list of connection objects.
</summary>
<param name="pLogConfig">An instance of LogConfig</param>
<param name="pConnections">A list of DispatcherConnection objects</param>
<seealso cref="M:DigitalData.Modules.Database.Dispatcher.Create(DigitalData.Modules.Logging.LogConfig,System.String)"/>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.GetDatatable(System.String,System.Int32)">
<summary>
Returns a Datatable from the database with the specified connection id
</summary>
<param name="pSQLCommand">The SQL query</param>
<param name="pConnectionId">The connection id</param>
<returns>A datatable with the results or nothing if an error occurred</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.GetDatatable(System.String)">
<summary>
Returns a Datatable from the database
</summary>
<param name="pSQLCommand">The SQL query</param>
<returns>A datatable with the results or nothing if an error occurred</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.ExecuteNonQuery(System.String,System.Int32)">
<summary>
Executes a query without return value like INSERT or UPDATE from the database with the specified connection id and
returns a boolean value indicating success or failure of the query
</summary>
<param name="pSQLCommand">The SQL query</param>
<param name="pConnectionId">The connection id</param>
<returns>True if the query was successful, otherwise false</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.ExecuteNonQuery(System.String)">
<summary>
Executes a query without return value like INSERT or UPDATE from the database and
returns a boolean value indicating success or failure of the query
</summary>
<param name="pSQLCommand">The SQL query</param>
<returns>True if the query was successful, otherwise false</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.GetScalarValue(System.String,System.Int32)">
<summary>
Returns a single value from the database specified by the connection id
</summary>
<param name="pSQLCommand">The SQL query</param>
<param name="pConnectionId">The connection id</param>
<returns>A value of type object</returns>
</member>
<member name="M:DigitalData.Modules.Database.Dispatcher.GetScalarValue(System.String)">
<summary>
Returns a single value from the database
</summary>
<param name="pSQLCommand">The SQL query</param>
<returns>A value of type object</returns>
</member>
<member name="T:DigitalData.Modules.Database.Firebird">
<summary>
MODULE: Firebird
VERSION: 0.0.0.4
DATE: 18.12.2018
DESCRIPTION:
DEPENDENCIES: NLog, >= 4.5.10
EntityFramework.Firebird, >= 6.4.0
FirebirdSql.Data.FirebirdClient, >= 6.4.0
PARAMETERS: LogConfig, DigitalData.Modules.Logging.LogConfig
The LogFactory containing the current log config. Used to instanciate the class logger for this and any dependent class
DataSource, String
The server where the database lives, for example 127.0.0.1 or dd-vmx09-vm03
Database, String
The location of the Database in the format `127.0.0.1:E:\Path\To\Database.FDB`
User, String
The user name to connect as
Password, String
The user's password
PROPERTIES: ConnectionEstablished, Boolean
If the last opened connection was successful
ConnectionFailed, Boolean
If the last opened connection failed
ConnectionString, String
The used connectionstring
EXAMPLES:
REMARKS: If the connection fails due to "wrong username or password", the cause might be that the server harddrive is full..
</summary>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.#ctor(DigitalData.Modules.Logging.LogConfig,System.String,System.String,System.String,System.String)">
<summary>
</summary>
<param name="LogConfig">The LogFactory containing the current log config. Used to instanciate the class logger for this and any dependent class</param>
<param name="Datasource">The server where the database lives, for example 127.0.0.1 or dd-vmx09-vm03</param>
<param name="Database">The location of the Database in the format `127.0.0.1:E:\Path\To\Database.FDB`</param>
<param name="User">The user name to connect as</param>
<param name="Password">The user's password</param>
<exception cref="T:DigitalData.Modules.Database.Exceptions.DatabaseException"></exception>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.GetConnectionString(System.String,System.String,System.String,System.String)">
<summary>
Builds a connectionstring from the provided arguments.
</summary>
<param name="DataSource">The database server where to connect to</param>
<param name="Database">The datasource, eg. the path of the FDB-file</param>
<param name="User">The user used to connect to the database</param>
<param name="Password">The password of the connecting user</param>
<returns>A connectionstring</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.ExecuteNonQueryWithConnection(System.String,FirebirdSql.Data.FirebirdClient.FbConnection,DigitalData.Modules.Database.Firebird.TransactionMode,FirebirdSql.Data.FirebirdClient.FbTransaction)">
<summary>
Executes a non-query command.
</summary>
<param name="SqlCommand">The command to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>True, if command was executed sucessfully. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.ExecuteNonQuery(System.String)">
<summary>
Executes a non-query command.
</summary>
<param name="SqlCommand">The command to execute</param>
<returns>True, if command was executed sucessfully. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.ExecuteNonQuery(System.String,FirebirdSql.Data.FirebirdClient.FbTransaction)">
<summary>
Executes a non-query command inside the specified transaction.
</summary>
<param name="SqlCommand">The command to execute</param>
<returns>True, if command was executed sucessfully. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.GetScalarValueWithConnection(System.String,FirebirdSql.Data.FirebirdClient.FbConnection,DigitalData.Modules.Database.Firebird.TransactionMode,FirebirdSql.Data.FirebirdClient.FbTransaction)">
<summary>
Executes a sql query resulting in a scalar value.
</summary>
<param name="SqlQuery">The query to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>The scalar value if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.GetScalarValue(System.String)">
<summary>
Executes a sql query resulting in a scalar value.
</summary>
<param name="SqlQuery">The query to execute</param>
<returns>The scalar value if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.GetDatatableWithConnection(System.String,FirebirdSql.Data.FirebirdClient.FbConnection,DigitalData.Modules.Database.Firebird.TransactionMode,FirebirdSql.Data.FirebirdClient.FbTransaction)">
<summary>
Executes a sql query resulting in a table of values.
</summary>
<param name="SqlQuery">The query to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>A datatable containing the results if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Firebird.GetDatatable(System.String,DigitalData.Modules.Database.Firebird.TransactionMode,FirebirdSql.Data.FirebirdClient.FbTransaction)">
<summary>
Executes a sql query resulting in a table of values.
</summary>
<param name="SqlQuery">The query to execute</param>
<returns>A datatable containing the results if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="P:DigitalData.Modules.Database.IDatabase.DBInitialized">
<summary>
Returns true if the initial connection to the configured database was successful.
</summary>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.ExecuteNonQueryWithConnection(System.String,System.Data.Odbc.OdbcConnection)">
<summary>
Executes a non-query command.
</summary>
<param name="SqlQuery">The command to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>True, if command was executed sucessfully. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.ExecuteNonQuery(System.String)">
<summary>
Executes a non-query command.
</summary>
<param name="SqlCommand">The command to execute</param>
<returns>True, if command was executed sucessfully. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.GetScalarValueWithConnection(System.String,System.Data.Odbc.OdbcConnection)">
<summary>
Executes a sql query resulting in a scalar value.
</summary>
<param name="SqlQuery">The query to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>The scalar value if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.GetScalarValue(System.String)">
<summary>
Executes a sql query resulting in a table of values.
</summary>
<param name="SqlQuery">The query to execute</param>
<returns>A datatable containing the results if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.GetDatatableWithConnection(System.String,System.Data.Odbc.OdbcConnection)">
<summary>
Executes a sql query resulting in a table of values.
</summary>
<param name="SqlQuery">The query to execute</param>
<param name="Connection">The Firebird connection to use</param>
<returns>A datatable containing the results if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.ODBC.GetDatatable(System.String)">
<summary>
Executes a sql query resulting in a table of values.
</summary>
<param name="SqlQuery">The query to execute</param>
<returns>A datatable containing the results if the command was executed successfully. Nothing otherwise.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Oracle.EncryptConnectionString(System.String)">
<summary>
Encrypts a connection string password.
</summary>
<param name="ConnectionString">A connection string with a plain-text password</param>
<returns>The connection string with the password encrypted.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Oracle.DecryptConnectionString(System.String)">
<summary>
Decrypts a connection string password.
</summary>
<param name="ConnectionString">A connection string with a encrypted password</param>
<returns>The connection string with the password decrypted.</returns>
</member>
<member name="M:DigitalData.Modules.Database.Oracle.NewExecutenonQuery(System.String)">
<summary>
Executes the passed sql-statement
</summary>
<param name="executeStatement">the sql statement</param>
<returns>Returns true if properly executed, else false</returns>
</member>
<member name="M:DigitalData.Modules.Database.Oracle.NewExecuteScalar(System.String)">
<summary>
Executes the passed sql-statement as Scalar
</summary>
<param name="executeStatement">the sql statement</param>
<returns>Returns the scalarvalue</returns>
</member>
<member name="M:DigitalData.Modules.Database.Oracle.OpenSQLConnection(Oracle.ManagedDataAccess.Client.OracleConnection)">
<summary>
This Function intentionally has no try..catch block to have any errors caught outside
</summary>
<param name="Connection"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.EncryptConnectionString(System.String)">
<summary>
Encrypts a connection string password.
</summary>
<param name="pConnectionString">A connection string with a plain-text password</param>
<returns>The connection string with the password encrypted.</returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.DecryptConnectionString(System.String)">
<summary>
Decrypts a connection string password.
</summary>
<param name="pConnectionString">A connection string with a encrypted password</param>
<returns>The connection string with the password decrypted.</returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.OpenSQLConnection(System.Data.SqlClient.SqlConnection)">
<summary>
This Function intentionally has no try..catch block to have any errors caught outside
</summary>
<param name="pConnection"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.GetDatatable(System.String,System.Int32)">
<summary>
Returns a Datatable for a SQL Statement
</summary>
<param name="pSqlCommand">SQL Command Text for Datatable (select XYZ from TableORView)</param>
<returns>A datatable</returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.GetDatatable(System.Data.SqlClient.SqlCommand,System.Int32)">
<summary>
Returns a datatable for a SQL Statement
</summary>
<param name="pSqlCommandObject">SQL Command Object for Datatable (select XYZ from TableORView)</param>
<returns>A datatable</returns>
</member>
<member name="M:DigitalData.Modules.Database.MSSQLServer.NewExecuteNonQueryAsync(System.String,System.Int32)">
<summary>
Executes the passed sql-statement in asyncmode
</summary>
<param name="SqlCommand">the sql statement</param>
<param name="commandtimeout">Optional Timeout</param>
<remarks></remarks>
</member>
</members>
</doc>