GPAL - Generally Positive Automation Library v1.0
GPAL The Fluent Automation LIbrary
Loading...
Searching...
No Matches
GenerallyPositive.GPALDatabase Class Reference

Class to define database usage. Currently only used for input from a table, sql or stored procedure.
Instantiated with GPAL.Database. More...

Inheritance diagram for GenerallyPositive.GPALDatabase:
GenerallyPositive.IGPALDatabase GenerallyPositive.IAllowDatabaseGridSettings GenerallyPositive.IAllowDatabaseSettings GenerallyPositive.IAllowToGPALObject< TResult > GenerallyPositive.IAllowDatabaseExecute GenerallyPositive.IAllowParametersAndInto GenerallyPositive.IAllowParametersAndUsing GenerallyPositive.IAllowParametersAndActions GenerallyPositive.IAllowPrecsionScaleAndSettings GenerallyPositive.IAllowParameterLength GenerallyPositive.IAllowDatabaseSettings

Classes

class  DatabaseError
 What went wrong on the last call, and enough about it to act on.
A failure hands the callback the database and nothing else, so everything it would need to ask about lives here: the server's own number for it, the sql that ran, the parameters it ran against, and which row of them was being written when it stopped. More...

Public Member Functions

delegate int CallOnError (GPALDatabase database)
IGPALDatabase ToGPALObject ()
IAllowDatabaseSettings WithConnectionString (string connectionString)
 Set the connectrion string used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.
IAllowDatabaseSettings WithUsername (string username)
 Set the username used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.
IAllowDatabaseSettings WithPassword (string password)
 Set the password used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.
IAllowDatabaseSettings WithSQLCommand (string sqlCommand)
 The SQL command to execute for the input data grid (tokens).
IAllowDatabaseSettings WithStoredProcedure (string storedProcedure)
 The stored procedure to execute for the input data grid (tokens).
IAllowDatabaseSettings WithParameterName (string parameterName)
 Add a parameter name to the parameter names list.
CAVEAT: we need to know the type of parameter, this gets as tedious as the columns.
IAllowParametersAndActions WithParameter (string parameter)
 Add a parameter to the parameters list.
.
IAllowParametersAndActions WithParameterGrid (IGPALGrid< string > parametersGrid)
 Add a parameter to the parameters list.
.
IAllowDatabaseSettings WithCreateAs (string sqlCommand)
IAllowDatabaseSettings WithReadAs (string sqlCommand)
IAllowDatabaseSettings WithUpdateAs (string sqlCommand)
IAllowDatabaseSettings WithDeleteAs (string sqlCommand)
IAllowDatabaseSettings WithDatabaseType (Enums.DatabaseType databaseType)
 Set the type of database GPAL is interacting with.
Currently only SQL Server is supported. (Do not need to specify).
IAllowDatabaseSettings WithServerName (string serverName)
 Set the database servername.
Used with databasename and [optional] usename/password to construct a connection string.
IAllowDatabaseSettings WithDatabaseName (string databaseName)
 Set the database instance name.
Used with database servername and [optional] usename/password to construct a connection string.
IAllowDatabaseSettings WithTableName (string tableName)
 Set the table name to query for input.
If no SQL command or stored procedure is defined, then GPAL will query the table supplied to get input data.
Use .WithRowCount to set the number of rows to select.
IAllowDatabaseSettings WithCommandTimeout (int timeoutInSeconds)
 Set the numbers of rows to select from the table.
IAllowDatabaseSettings Close ()
 Closes the connection and rolls back a transaction still open on it. The database can be used again afterwards: the next action opens a new connection from the same settings.
void Dispose ()
 Closes the connection, so a database can be held in a using block. Same work as Close.
IAllowDatabaseSettings WithRowCount (int rowCount)
Public Member Functions inherited from GenerallyPositive.IAllowDatabaseSettings
IAllowDatabaseSettings WithDatabaseType (DatabaseType databaseType)
Public Member Functions inherited from GenerallyPositive.IAllowDatabaseUsing
IAllowDatabaseExecute Using (System.Data.DataTable dataTable)
Public Member Functions inherited from GenerallyPositive.IAllowDatabaseInto
IAllowDatabaseSettings SaveTo (out System.Data.DataTable dataTable)
IAllowDatabaseSettings SaveTo (out System.Data.DataSet dataSet)

Properties

DatabaseError LastError [get, set]
 The last failure, or null when the last call did not fail. Cleared at the start of every call, so it always describes the most recent one.
IAllowParametersAndUsing Create [get]
IAllowParametersAndInto Read [get]
IAllowParametersAndUsing Update [get]
IAllowParametersAndUsing Delete [get]
IAllowParameters ClearParameters [get]
 If you have already defined parameter objectss on a GPAL.Database, you can clear them and add new parameter objects;.
IGPALGrid< string > Tokens [get, set]
 The rows/columns returned from the database.
Tokens are loaded upon calling any [Append/FillIn/Insert]FromDatabase method.
Intended for debugging only.
IAllowParametersAndActions BeginTransaction [get]
IAllowDatabaseActions Rollback [get]
IAllowDatabaseActions Commit [get]

</param>

Define a NText column

Parameters
parameterNameThe parameter name, which is how the sql refers to it:
Returns
Fluent interface to define more database settings
IAllowDatabaseSettings WithDatetimeParameter (string parameterName)
IAllowDatabaseSettings WithTimeParameter (string parameterName)
IAllowDatabaseSettings WithTimestampParameter (string parameterName)
IAllowPrecsionScaleAndSettings WithDecimalParameter (string parameterName)
IAllowDatabaseSettings WithFloatParameter (string parameterName)
IAllowDatabaseSettings WithImageParameter (string parameterName)
IAllowDatabaseSettings WithIntegerParameter (string parameterName)
IAllowDatabaseSettings WithMoneyParameter (string parameterName)
IAllowParameterLength WithCharParameter (string parameterName)
IAllowParameterLength WithNCharParameter (string parameterName)
IAllowParameterLength WithVarCharParameter (string parameterName)
IAllowParameterLength WithNVarCharParameter (string parameterName)
IAllowParameterLength WithTextParameter (string parameterName)
IAllowParameterLength WithNTextParameter (string parameterName)
IAllowDatabaseSettings WithParameterLength (int length)
IAllowPrecsionScaleAndSettings WithParameterPrecision (int columnPrecision)
IAllowPrecsionScaleAndSettings WithParameterScale (int columnScale)
IAllowDatabaseSettings WithTableParameter (string parameterName)
IAllowDatabaseSettings WithUDTTName (string typeName)
IAllowDatabaseExecute Using (IGPALGrid< string > parametersGrid)
IAllowDatabaseExecute Using (DataTable dataTable)
IAllowDatabaseGridSettings SaveTo (out IGPALGrid< string > dataGrid)
IAllowDatabaseSettings GetRowCount (out List< int > rowCountsPerTable)
 Only SaveTo(out IGPALGrid<string>) returns this - meaningless for SaveTo(DataTable)/SaveTo(DataSet), which already separate results by table. Optional to call: tells you how many of the grid's rows belong to each result set the query returned, in order, since a flat grid otherwise can't signal where one table's rows end and the next begin.
IAllowDatabaseSettings SaveTo (out DataTable dataTable)
IAllowDatabaseSettings SaveTo (out DataSet dataSet)
IAllowDatabaseSettings SaveTo (out string value)
 Reads a single value: the first column of the first row, without building a grid around it. A count, a maximum, a status. Null when the query returned no rows, or returned null.
IAllowParametersAndActions Execute (out int rowCount)
IAllowParametersAndActions Execute (out List< int > rowCountsPerStatement)
 Per-statement breakdown (via SqlCommand.StatementCompleted) instead of the single aggregate count.
IAllowDatabaseSettings WithErrorCallback (GPALDatabase.CallOnError callOnError)

Detailed Description

Class to define database usage. Currently only used for input from a table, sql or stored procedure.
Instantiated with GPAL.Database.

Definition at line 33 of file GPALDatabase.cs.

Member Function Documentation

◆ Close()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.Close ( )

Closes the connection and rolls back a transaction still open on it. The database can be used again afterwards: the next action opens a new connection from the same settings.

Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 445 of file GPALDatabase.cs.

◆ Dispose()

void GenerallyPositive.GPALDatabase.Dispose ( )

Closes the connection, so a database can be held in a using block. Same work as Close.

Definition at line 454 of file GPALDatabase.cs.

◆ Execute() [1/2]

IAllowParametersAndActions GenerallyPositive.GPALDatabase.Execute ( out int rowCount)

Implements GenerallyPositive.IAllowDatabaseExecute.

Definition at line 727 of file GPALDatabase.cs.

◆ Execute() [2/2]

IAllowParametersAndActions GenerallyPositive.GPALDatabase.Execute ( out List< int > rowCountsPerStatement)

Per-statement breakdown (via SqlCommand.StatementCompleted) instead of the single aggregate count.

Implements GenerallyPositive.IAllowDatabaseExecute.

Definition at line 733 of file GPALDatabase.cs.

◆ GetRowCount()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.GetRowCount ( out List< int > rowCountsPerTable)

Only SaveTo(out IGPALGrid<string>) returns this - meaningless for SaveTo(DataTable)/SaveTo(DataSet), which already separate results by table. Optional to call: tells you how many of the grid's rows belong to each result set the query returned, in order, since a flat grid otherwise can't signal where one table's rows end and the next begin.

Implements GenerallyPositive.IAllowDatabaseGridSettings.

Definition at line 689 of file GPALDatabase.cs.

◆ SaveTo() [1/4]

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.SaveTo ( out DataSet dataSet)

Definition at line 701 of file GPALDatabase.cs.

◆ SaveTo() [2/4]

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.SaveTo ( out DataTable dataTable)

Definition at line 695 of file GPALDatabase.cs.

◆ SaveTo() [3/4]

IAllowDatabaseGridSettings GenerallyPositive.GPALDatabase.SaveTo ( out IGPALGrid< string > dataGrid)

Implements GenerallyPositive.IAllowDatabaseInto.

Definition at line 683 of file GPALDatabase.cs.

◆ SaveTo() [4/4]

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.SaveTo ( out string value)

Reads a single value: the first column of the first row, without building a grid around it. A count, a maximum, a status. Null when the query returned no rows, or returned null.

database
.WithSQLCommand("select count(*) from Orders where Shipped is null")
.Read
.SaveTo(out string waiting);
Parameters
valueReceives the value read.
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseInto.

Definition at line 721 of file GPALDatabase.cs.

◆ ToGPALObject()

IGPALDatabase GenerallyPositive.GPALDatabase.ToGPALObject ( )

Implements GenerallyPositive.IAllowToGPALObject< TResult >.

Definition at line 82 of file GPALDatabase.cs.

◆ Using() [1/2]

IAllowDatabaseExecute GenerallyPositive.GPALDatabase.Using ( DataTable dataTable)

Definition at line 675 of file GPALDatabase.cs.

◆ Using() [2/2]

IAllowDatabaseExecute GenerallyPositive.GPALDatabase.Using ( IGPALGrid< string > parametersGrid)

Implements GenerallyPositive.IAllowDatabaseUsing.

Definition at line 669 of file GPALDatabase.cs.

◆ WithCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithCharParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 559 of file GPALDatabase.cs.

◆ WithCommandTimeout()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithCommandTimeout ( int timeoutInSeconds)

Set the numbers of rows to select from the table.

// Open database GPAL on server HORNET\SqlServer using integrated security, query 4 rows from the top of table TestInput
Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithTableName("TestInput")
.WithRowCount(4);
Everything starts here, all the GPAL controls and global settings using fluent syntax are here....
Definition GPAL.cs:49
static IAllowDatabaseSettings Database
Instantiates a new fluent Database SETTINGS object. This data object defines settings for use by ....
Definition GPAL.cs:660
Parameters
rowCount
Returns
Fluent interface to define more database settings

How long a command may run before the provider gives up on it. Nothing said leaves the provider's own default in place, which is thirty seconds for SQL Server. A report that takes two minutes and an update across a large table both need saying so.

database.WithCommandTimeout(300); // five minutes
Parameters
timeoutInSecondsSeconds a command may run. Zero is the provider's word for no limit.
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 434 of file GPALDatabase.cs.

◆ WithConnectionString()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithConnectionString ( string connectionString)

Set the connectrion string used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.

Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithTableName("TestInput")
.WithRowCount(4);
Parameters
connectionStringThe connection string
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 217 of file GPALDatabase.cs.

◆ WithCreateAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithCreateAs ( string sqlCommand)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 297 of file GPALDatabase.cs.

◆ WithDatabaseName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDatabaseName ( string databaseName)

Set the database instance name.
Used with database servername and [optional] usename/password to construct a connection string.

// Open database GPAL on server HORNET\SqlServer using integrated security, query 4 rows from the top of table TestInput
Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithTableName("TestInput")
.WithRowCount(4);
Parameters
serverNameThe database instance name
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 380 of file GPALDatabase.cs.

◆ WithDatabaseType()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDatabaseType ( Enums.DatabaseType databaseType)

Set the type of database GPAL is interacting with.
Currently only SQL Server is supported. (Do not need to specify).

// Open database GPAL on server HORNET\SqlServer using integrated security, query 4 rows from the top of table TestInput
Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithDatabaseType(DatabaseType.SQLServer)
.WithTableName("TestInput")
.WithRowCount(4);
Parameters
databaseTypeThe database type. SQLServer is the only one GPAL speaks.
Returns
Fluent interface to define more database settings

Definition at line 338 of file GPALDatabase.cs.

◆ WithDatetimeParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDatetimeParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 471 of file GPALDatabase.cs.

◆ WithDecimalParameter()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithDecimalParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 504 of file GPALDatabase.cs.

◆ WithDeleteAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDeleteAs ( string sqlCommand)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 315 of file GPALDatabase.cs.

◆ WithErrorCallback()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithErrorCallback ( GPALDatabase.CallOnError callOnError)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 761 of file GPALDatabase.cs.

◆ WithFloatParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithFloatParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 515 of file GPALDatabase.cs.

◆ WithImageParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithImageParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 526 of file GPALDatabase.cs.

◆ WithIntegerParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithIntegerParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 537 of file GPALDatabase.cs.

◆ WithMoneyParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithMoneyParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 548 of file GPALDatabase.cs.

◆ WithNCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNCharParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 571 of file GPALDatabase.cs.

◆ WithNTextParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNTextParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 619 of file GPALDatabase.cs.

◆ WithNVarCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNVarCharParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 595 of file GPALDatabase.cs.

◆ WithParameter()

IAllowParametersAndActions GenerallyPositive.GPALDatabase.WithParameter ( string parameter)

Add a parameter to the parameters list.
.

Parameters
parameterThe stored procedure parameter
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowParameters.

Definition at line 280 of file GPALDatabase.cs.

◆ WithParameterGrid()

IAllowParametersAndActions GenerallyPositive.GPALDatabase.WithParameterGrid ( IGPALGrid< string > parametersGrid)

Add a parameter to the parameters list.
.

Parameters
parameterThe stored procedure parameter
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowParameters.

Definition at line 291 of file GPALDatabase.cs.

◆ WithParameterLength()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithParameterLength ( int length)

Implements GenerallyPositive.IAllowParameterLength.

Definition at line 626 of file GPALDatabase.cs.

◆ WithParameterName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithParameterName ( string parameterName)

Add a parameter name to the parameter names list.
CAVEAT: we need to know the type of parameter, this gets as tedious as the columns.

Parameters
parameterNameThe stored procedure parameter
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 270 of file GPALDatabase.cs.

◆ WithParameterPrecision()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithParameterPrecision ( int columnPrecision)

Implements GenerallyPositive.IAllowColumnPrecision.

Definition at line 632 of file GPALDatabase.cs.

◆ WithParameterScale()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithParameterScale ( int columnScale)

Implements GenerallyPositive.IAllowColumnScale.

Definition at line 638 of file GPALDatabase.cs.

◆ WithPassword()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithPassword ( string password)

Set the password used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.

Parameters
connectionStringThe connection string
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 239 of file GPALDatabase.cs.

◆ WithReadAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithReadAs ( string sqlCommand)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 303 of file GPALDatabase.cs.

◆ WithRowCount()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithRowCount ( int rowCount)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 459 of file GPALDatabase.cs.

◆ WithServerName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithServerName ( string serverName)

Set the database servername.
Used with databasename and [optional] usename/password to construct a connection string.

// Open database GPAL on server HORNET\SqlServer using integrated security, query 4 rows from the top of table TestInput
Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithTableName("TestInput")
.WithRowCount(4);
Parameters
serverNameThe server name
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 359 of file GPALDatabase.cs.

◆ WithSQLCommand()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithSQLCommand ( string sqlCommand)

The SQL command to execute for the input data grid (tokens).

Parameters
sqlCommandThe SQL command to run
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 249 of file GPALDatabase.cs.

◆ WithStoredProcedure()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithStoredProcedure ( string storedProcedure)

The stored procedure to execute for the input data grid (tokens).

Parameters
sqlCommandThe SQL command to run
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 259 of file GPALDatabase.cs.

◆ WithTableName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTableName ( string tableName)

Set the table name to query for input.
If no SQL command or stored procedure is defined, then GPAL will query the table supplied to get input data.
Use .WithRowCount to set the number of rows to select.

// Open database GPAL on server HORNET\SqlServer using integrated security, query 4 rows from the top of table TestInput
Database database = (Database)GPAL.Database
.WithServerName(@"HORNET\SqlServer")
.WithDatabaseName("GPAL")
.WithTableName("TestInput")
.WithRowCount(4);
Parameters
tableNameThe table name
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 402 of file GPALDatabase.cs.

◆ WithTableParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTableParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 644 of file GPALDatabase.cs.

◆ WithTextParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithTextParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 607 of file GPALDatabase.cs.

◆ WithTimeParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTimeParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 482 of file GPALDatabase.cs.

◆ WithTimestampParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTimestampParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 493 of file GPALDatabase.cs.

◆ WithUDTTName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithUDTTName ( string typeName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 651 of file GPALDatabase.cs.

◆ WithUpdateAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithUpdateAs ( string sqlCommand)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 309 of file GPALDatabase.cs.

◆ WithUsername()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithUsername ( string username)

Set the username used to connect to the database.
If no connection string is provided, GPAL will construct one from the server and database name, and if supplied, username and password.

Parameters
connectionStringThe connection string
Returns
Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 228 of file GPALDatabase.cs.

◆ WithVarCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithVarCharParameter ( string parameterName)

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 583 of file GPALDatabase.cs.

Property Documentation

◆ BeginTransaction

IAllowParametersAndActions GenerallyPositive.GPALDatabase.BeginTransaction
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 156 of file GPALDatabase.cs.

◆ ClearParameters

IAllowParameters GenerallyPositive.GPALDatabase.ClearParameters
get

If you have already defined parameter objectss on a GPAL.Database, you can clear them and add new parameter objects;.

Implements GenerallyPositive.IAllowParameters.

Definition at line 128 of file GPALDatabase.cs.

◆ Commit

IAllowDatabaseActions GenerallyPositive.GPALDatabase.Commit
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 190 of file GPALDatabase.cs.

◆ Create

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Create
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 93 of file GPALDatabase.cs.

◆ Delete

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Delete
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 117 of file GPALDatabase.cs.

◆ LastError

DatabaseError GenerallyPositive.GPALDatabase.LastError
getset

The last failure, or null when the last call did not fail. Cleared at the start of every call, so it always describes the most recent one.

Definition at line 70 of file GPALDatabase.cs.

◆ Read

IAllowParametersAndInto GenerallyPositive.GPALDatabase.Read
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 101 of file GPALDatabase.cs.

◆ Rollback

IAllowDatabaseActions GenerallyPositive.GPALDatabase.Rollback
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 180 of file GPALDatabase.cs.

◆ Tokens

IGPALGrid<string> GenerallyPositive.GPALDatabase.Tokens
getset

The rows/columns returned from the database.
Tokens are loaded upon calling any [Append/FillIn/Insert]FromDatabase method.
Intended for debugging only.

Returns
A GPALGrid of tokens

Implements GenerallyPositive.IGPALDatabase.

Definition at line 144 of file GPALDatabase.cs.

◆ Update

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Update
get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 109 of file GPALDatabase.cs.


The documentation for this class was generated from the following file: