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:

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 ()
	Hands back the whole database, which is also how a chain gets from describing one to using one. Every setting answers with IAllowDatabaseSettings, which carries the settings and the parameter definitions and nothing else: no parameter values, no Execute, no SaveTo, no verbs. This answers with IGPALDatabase, which carries all of them. So a chain says what the database is, calls this, and then says what to do with it.
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

parameterName

The 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 477 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 486 of file GPALDatabase.cs.

◆ Execute() [1/2]

IAllowParametersAndActions GenerallyPositive.GPALDatabase.Execute ( out int rowCount )

Implements GenerallyPositive.IAllowDatabaseExecute.

Definition at line 791 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 797 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 753 of file GPALDatabase.cs.

◆ SaveTo() [1/4]

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.SaveTo ( out DataSet dataSet )

Definition at line 765 of file GPALDatabase.cs.

◆ SaveTo() [2/4]

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.SaveTo ( out DataTable dataTable )

Definition at line 759 of file GPALDatabase.cs.

◆ SaveTo() [3/4]

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

Implements GenerallyPositive.IAllowDatabaseInto.

Definition at line 747 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

value Receives the value read.

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseInto.

Definition at line 785 of file GPALDatabase.cs.

◆ ToGPALObject()

IGPALDatabase GenerallyPositive.GPALDatabase.ToGPALObject ( )

Hands back the whole database, which is also how a chain gets from describing one to using one.
Every setting answers with IAllowDatabaseSettings, which carries the settings and the parameter definitions and nothing else: no parameter values, no Execute, no SaveTo, no verbs. This answers with IGPALDatabase, which carries all of them. So a chain says what the database is, calls this, and then says what to do with it.

GPAL.Database
    .WithServerName(@"HORNET2\DEADMIKE")
    .WithDatabaseName("GPAL")
    .WithDatabaseType(DatabaseType.SQLServer)
    .WithSQLCommand("insert into Orders (Name, Tally) values (@Name, @Tally)")
    .WithVarCharParameter("Name").WithParameterLength(50)
    .WithIntegerParameter("Tally")
    .ToGPALObject()   // settings above, actions below
    .WithParameter("first")
    .WithParameter("1")
    .Execute(out int inserted);

Returns: The database, on the interface that can run something

Implements GenerallyPositive.IAllowToGPALObject< TResult >.

Definition at line 105 of file GPALDatabase.cs.

◆ Using() [1/2]

IAllowDatabaseExecute GenerallyPositive.GPALDatabase.Using ( DataTable dataTable )

Definition at line 739 of file GPALDatabase.cs.

◆ Using() [2/2]

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

Implements GenerallyPositive.IAllowDatabaseUsing.

Definition at line 733 of file GPALDatabase.cs.

◆ WithCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithCharParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 599 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);

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

timeoutInSeconds Seconds 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 466 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

connectionString The connection string

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 249 of file GPALDatabase.cs.

◆ WithCreateAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithCreateAs ( string sqlCommand )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 329 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

serverName The database instance name

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 412 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

databaseType The database type. SQLServer is the only one GPAL speaks.

Returns: Fluent interface to define more database settings

Definition at line 370 of file GPALDatabase.cs.

◆ WithDatetimeParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDatetimeParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 503 of file GPALDatabase.cs.

◆ WithDecimalParameter()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithDecimalParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 539 of file GPALDatabase.cs.

◆ WithDeleteAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithDeleteAs ( string sqlCommand )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 347 of file GPALDatabase.cs.

◆ WithErrorCallback()

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

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 825 of file GPALDatabase.cs.

◆ WithFloatParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithFloatParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 551 of file GPALDatabase.cs.

◆ WithImageParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithImageParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 563 of file GPALDatabase.cs.

◆ WithIntegerParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithIntegerParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 575 of file GPALDatabase.cs.

◆ WithMoneyParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithMoneyParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 587 of file GPALDatabase.cs.

◆ WithNCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNCharParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 611 of file GPALDatabase.cs.

◆ WithNTextParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNTextParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 659 of file GPALDatabase.cs.

◆ WithNVarCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithNVarCharParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 635 of file GPALDatabase.cs.

◆ WithParameter()

IAllowParametersAndActions GenerallyPositive.GPALDatabase.WithParameter ( string parameter )

Add a parameter to the parameters list.
.

Parameters

parameter The stored procedure parameter

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowParameters.

Definition at line 312 of file GPALDatabase.cs.

◆ WithParameterGrid()

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

Add a parameter to the parameters list.
.

Parameters

parameter The stored procedure parameter

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowParameters.

Definition at line 323 of file GPALDatabase.cs.

◆ WithParameterLength()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithParameterLength ( int length )

Implements GenerallyPositive.IAllowParameterLength.

Definition at line 666 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

parameterName The stored procedure parameter

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 302 of file GPALDatabase.cs.

◆ WithParameterPrecision()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithParameterPrecision ( int columnPrecision )

Implements GenerallyPositive.IAllowColumnPrecision.

Definition at line 674 of file GPALDatabase.cs.

◆ WithParameterScale()

IAllowPrecsionScaleAndSettings GenerallyPositive.GPALDatabase.WithParameterScale ( int columnScale )

Implements GenerallyPositive.IAllowColumnScale.

Definition at line 682 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

connectionString The connection string

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 271 of file GPALDatabase.cs.

◆ WithReadAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithReadAs ( string sqlCommand )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 335 of file GPALDatabase.cs.

◆ WithRowCount()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithRowCount ( int rowCount )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 491 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

serverName The server name

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 391 of file GPALDatabase.cs.

◆ WithSQLCommand()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithSQLCommand ( string sqlCommand )

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

Parameters

sqlCommand The SQL command to run

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 281 of file GPALDatabase.cs.

◆ WithStoredProcedure()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithStoredProcedure ( string storedProcedure )

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

Parameters

sqlCommand The SQL command to run

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 291 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

tableName The table name

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 434 of file GPALDatabase.cs.

◆ WithTableParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTableParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 708 of file GPALDatabase.cs.

◆ WithTextParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithTextParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 647 of file GPALDatabase.cs.

◆ WithTimeParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTimeParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 515 of file GPALDatabase.cs.

◆ WithTimestampParameter()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithTimestampParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 527 of file GPALDatabase.cs.

◆ WithUDTTName()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithUDTTName ( string typeName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 715 of file GPALDatabase.cs.

◆ WithUpdateAs()

IAllowDatabaseSettings GenerallyPositive.GPALDatabase.WithUpdateAs ( string sqlCommand )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 341 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

connectionString The connection string

Returns: Fluent interface to define more database settings

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 260 of file GPALDatabase.cs.

◆ WithVarCharParameter()

IAllowParameterLength GenerallyPositive.GPALDatabase.WithVarCharParameter ( string parameterName )

Implements GenerallyPositive.IAllowDatabaseSettings.

Definition at line 623 of file GPALDatabase.cs.

Property Documentation

◆ BeginTransaction

IAllowParametersAndActions GenerallyPositive.GPALDatabase.BeginTransaction

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 186 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 158 of file GPALDatabase.cs.

◆ Commit

IAllowDatabaseActions GenerallyPositive.GPALDatabase.Commit

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 221 of file GPALDatabase.cs.

◆ Create

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Create

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 119 of file GPALDatabase.cs.

◆ Delete

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Delete

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 146 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 128 of file GPALDatabase.cs.

◆ Rollback

IAllowDatabaseActions GenerallyPositive.GPALDatabase.Rollback

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 210 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 174 of file GPALDatabase.cs.

◆ Update

IAllowParametersAndUsing GenerallyPositive.GPALDatabase.Update

get

Implements GenerallyPositive.IAllowDatabaseActions.

Definition at line 137 of file GPALDatabase.cs.

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

Common/GPALDatabase.cs

Classes

Public Member Functions

Properties

</param>

Detailed Description

Member Function Documentation

◆ Close()

◆ Dispose()

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ GetRowCount()

◆ SaveTo() [1/4]

◆ SaveTo() [2/4]

◆ SaveTo() [3/4]

◆ SaveTo() [4/4]

◆ ToGPALObject()

◆ Using() [1/2]

◆ Using() [2/2]

◆ WithCharParameter()

◆ WithCommandTimeout()

◆ WithConnectionString()

◆ WithCreateAs()

◆ WithDatabaseName()

◆ WithDatabaseType()

◆ WithDatetimeParameter()

◆ WithDecimalParameter()

◆ WithDeleteAs()

◆ WithErrorCallback()

◆ WithFloatParameter()

◆ WithImageParameter()

◆ WithIntegerParameter()

◆ WithMoneyParameter()

◆ WithNCharParameter()

◆ WithNTextParameter()

◆ WithNVarCharParameter()

◆ WithParameter()

◆ WithParameterGrid()

◆ WithParameterLength()

◆ WithParameterName()

◆ WithParameterPrecision()

◆ WithParameterScale()

◆ WithPassword()

◆ WithReadAs()

◆ WithRowCount()

◆ WithServerName()

◆ WithSQLCommand()

◆ WithStoredProcedure()

◆ WithTableName()

◆ WithTableParameter()

◆ WithTextParameter()

◆ WithTimeParameter()

◆ WithTimestampParameter()

◆ WithUDTTName()

◆ WithUpdateAs()

◆ WithUsername()

◆ WithVarCharParameter()

Property Documentation

◆ BeginTransaction

◆ ClearParameters

◆ Commit

◆ Create

◆ Delete

◆ LastError

◆ Read

◆ Rollback

◆ Tokens

◆ Update