Gemstone.Data
Specifies the database type underlying an .
Underlying ADO database type is Microsoft Access.
Underlying ADO database type is SQL Server.
Underlying ADO database type is MySQL.
Underlying ADO database type is Oracle.
Underlying ADO database type is SQLite.
Underlying ADO database type is PostgreSQL.
Underlying ADO database type is unknown.
Creates a new from any specified or configured ADO.NET data source.
Example connection and data provider strings:
Database type
Example connection string / data provider string
-
SQL Server
ConnectionString = "Data Source=serverName; Initial Catalog=databaseName; User ID=userName; Password=password"
DataProviderString = "AssemblyName=Microsoft.Data.SqlClient; ConnectionType=Microsoft.Data.SqlClient.SqlConnection"
-
SQLite
ConnectionString = "Data Source=databaseName.db; Version=3; Foreign Keys=True; FailIfMissing=True"
DataProviderString = "AssemblyName=Microsoft.Data.Sqlite; ConnectionType=Microsoft.Data.Sqlite.SqliteConnection"
-
PostgreSQL
ConnectionString = "Host=localhost; Database=DatabaseName; Username=postgres; Password=password"
DataProviderString = "AssemblyName=Npgsql; ConnectionType=Npgsql.NpgsqlConnection"
-
MySQL
ConnectionString = "Server=serverName; Database=databaseName; Uid=root; Pwd=password; allow user variables = true"
DataProviderString = "AssemblyName=MySql.Data; ConnectionType=MySql.Data.MySqlClient.MySqlConnection"
-
Oracle
ConnectionString = "Data Source=tnsName; User ID=schemaUserName; Password=schemaPassword"
DataProviderString = "AssemblyName=Oracle.ManagedDataAccess; ConnectionType=Oracle.ManagedDataAccess.Client.OracleConnection"
Example configuration file that defines connection settings:
]]>
Creates and opens a new from specified .
Settings instance.
Creates and opens a new from specified and .
Database specific ADO connection string.
Key/value pairs that define which ADO assembly and types to load.
Creates and opens a new from specified
and .
Database specific ADO connection string.
The ADO type used to establish the database connection.
Creates a new from specified .
The database connection.
True if the database connection should be closed when the is disposed; false otherwise.
Releases the unmanaged resources before the object is reclaimed by .
Gets an open to configured ADO.NET data source.
Gets or sets the type of the database underlying the .
This value is automatically assigned based on the connection type specified in the data provider string, however,
if the database type cannot be determined it will be set to . In this
case, if you know the behavior of your custom ADO database connection matches that of another defined database
type, you can manually assign the database type to allow for database interaction interoperability.
Gets or sets default timeout for data operations.
Gets current UTC date-time in an implementation that is proper for the connected database type.
Gets the default for the connected database type.
Gets a value to indicate whether source database is Microsoft Access.
Gets a value to indicate whether source database is Microsoft SQL Server.
Gets a value to indicate whether source database is MySQL.
Gets a value to indicate whether source database is Oracle.
Gets a value to indicate whether source database is SQLite.
Gets a value to indicate whether source database is PostgreSQL.
Executes the given SQL script using .
The path to the SQL script.
Executes the given SQL script using .
The reader used to extract SQL statements to be executed.
Executes the SQL statement using , and returns the number of rows affected.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
The number of rows affected.
Executes the SQL statement using , and builds a .
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and builds a .
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and builds a .
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and builds a .
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and builds a .
One of the values.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and builds a .
One of the values.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object and its associated command.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The value to be substituted if is retrieved.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The value to be substituted if is retrieved.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The value to be substituted if is retrieved.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The value to be substituted if is retrieved.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The type to which the result of the query should be converted.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The type to which the result of the query should be converted.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The type to which the result of the query should be converted.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type .
The type to which the result of the query should be converted.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The type to which the result of the query should be converted.
The value to be substituted if is retrieved.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The type to which the result of the query should be converted.
The value to be substituted if is retrieved.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The type to which the result of the query should be converted.
The value to be substituted if is retrieved.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set as type , substituting
if is retrieved.
The type to which the result of the query should be converted.
The value to be substituted if is retrieved.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the first in the result set.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
Format string for the SQL statement to be executed.
The first in the result set, or null.
The parameter values to be used to fill in parameters.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Tries to retrieve the first in the result set of the SQL statement using .
Format string for the SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
The first in the result set, or null.
The parameter values to be used to fill in parameters.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
Format string for the SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table, as an asynchronous enumerable.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
An asynchronous enumerable of objects.
This method first reads data into memory as a then enumerates over its rows.
If the schema can be derived in advance, use the
overload instead that takes the schema and uses a to enumerate over the
rows directly without caching into memory first as an optimization.
Executes the SQL statement using using a and returns
data rows based on the provided as an asynchronous enumerable.
that defines the schema for the data rows.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
An asynchronous enumerable of objects.
If provided does not match the schema of the result set based on ,
the results may be unpredictable or method call may fail.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains at least one table, as an asynchronous enumerable.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
An asynchronous enumerable of objects.
This method first reads data into memory as a then enumerates over its rows.
If the schema can be derived in advance, use the
overload instead that takes the schema and uses a to enumerate over the
rows directly without caching into memory first as an optimization.
Executes the SQL statement using using a and returns
data rows based on the provided as an asynchronous enumerable.
that defines the schema for the data rows.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
An asynchronous enumerable of objects.
If provided does not match the schema of the result set based on ,
the results may be unpredictable or method call may fail.
Executes the SQL statement using using a and returns
data rows based on the provided as an asynchronous enumerable.
that defines the schema for the data rows.
One of the values.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
An asynchronous enumerable of objects.
If provided does not match the schema of the result set based on ,
the results may be unpredictable or method call may fail.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
The parameter values to be used to fill in parameters.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The time in seconds to wait for the SQL statement to execute.
Format string for the SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters.
A object.
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Asynchronously releases the resources used by the object.
Escapes an identifier, e.g., a table or field name, using the common delimiter for the connected
database type or the standard ANSI escaping delimiter, i.e., double-quotes, based on the flag.
Field name to escape.
Force use of double-quote for identifier delimiter, per SQL-99 standard, regardless of database type.
Escaped identifier name.
value cannot be null, empty or whitespace.
Returns proper implementation for connected database type.
to format per database type.
Proper implementation for connected database type.
Returns proper implementation for connected database type.
to format per database type.
Proper implementation for connected database type.
Retrieves from a field based on database type.
from which value needs to be retrieved.
Name of the field which contains .
.
Creates a parameterized query string for the underlying database type based on the given format string and parameter names.
A composite format string.
A string array that contains zero or more parameter names to format.
A parameterized query string based on the given format and parameter names.
Generates a data provider string for the given connection type.
The type used to establish a connection to the database.
The data provider string for the given connection type.
This is the common interface for any bulk data operation
Get the status information of table progress
Get the information of Row progress of table
Get the information of overall progress of Migration utility
Get the information of exception while processing SQL statement
Get the work table information
From schema information
To Schema information
Get the row report interval information
Get or set time out for SQL statement
Execute a method of object
Close the object connection
This class defines a common set of functionality that any bulk data operation implementation can use
Implementer can use this variable to track overall progress
This is initialized to the overall total number of records to be processed
Defines interval for reporting row progress
Tables value
Flag to check referential integrity
Get the status information of table progress
Get the information of Row progress of table
Get the information of overall progress of Migration utility
Get the information of exception while processing SQL statement
Default Constructor
Constructor with parameters
Source database connection string
Destination database connection string
Constructor with parameters
Source Schema
Destination Schema
Get or set Source schema
Get or set destination schema
Get or set number of rows to process before raising progress events
Get or set Maximum number of seconds to wait when processing a SQL command before timing out.
Get or set - use referential integrity information from source/to destination database during data processing
These are the tables that were found in both source and destination to be used for data operation...
Get list of tables to be excluded during data processing
Dispose
Close source and destination schema
Dispose
Analyze data schema before data processing
Executes bulk data operation.
Raise an event if table change in data processing
Table name in data processing
Status of data processing on table
current table index in data processing
total table count in data processing
Raise an event while change row in data processing
Table name in data processing
current row index in data processing
total rows needs to be process in data processing
Raise an event to show overall progress of data processing
Current index of tables in data processing
Total table count in data processing
Raise an event if SQL statement fail
SQL statement information
exception information
This class defines a common set of functionality that any data operation implementation can use
Disposed event.
Creates a new .
Creates a new .
Creates a new .
Close
Execute this
Execute a command to delete data from source to destination table
Source table
Destination table
Defines extension functions related to database and SQL interaction.
The default timeout duration used for executing SQL statements when timeout duration is not specified.
Performs SQL encoding on given SQL string.
The string on which SQL encoding is to be performed.
Database type for the SQL encoding.
The SQL encoded string.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and returns the number of rows affected.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The number of rows affected.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
One of the values.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
One of the values.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object and its associated command.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
One of the values.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and builds a .
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
One of the values.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the SQL statement using , and returns the value in the first column
of the first row in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Value in the first column of the first row in the result set.
Executes the statements defined in the given TSQL script.
The connection used to execute SQL statements.
The path to the SQL script.
Executes the statements defined in the given TSQL script.
The connection used to execute SQL statements.
The reader used to extract statements from the SQL script.
Executes the statements defined in the given MySQL script.
The connection used to execute SQL statements.
The path to the SQL script.
Executes the statements defined in the given MySQL script.
The connection used to execute SQL statements.
The reader used to extract statements from the SQL script.
Executes the statements defined in the given Oracle database script.
The connection used to execute SQL statements.
The path to the SQL script.
Executes the statements defined in the given Oracle database script.
The connection used to execute SQL statements.
The reader used to extract statements from the SQL script.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The first in the result set, or null.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
The first in the result set, or null.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Executes the SQL statement using , and returns the first in the result set.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The first in the result set, or null.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
The first in the result set, or null.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
The first in the result set.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Tries to retrieve the first in the result set of the SQL statement using .
The to use for executing the SQL statement.
The SQL statement to be executed.
The time in seconds to wait for the SQL statement to execute.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
Tuple of first in the result set (can be null) and a flag that determines if retrieve was successful.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the first
of result set, if the result set contains multiple tables.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Executes the SQL statement using , and returns the that
may contain multiple tables, depending on the SQL statement.
The to use for executing the SQL statement.
The time in seconds to wait for the SQL statement to execute.
The SQL statement to be executed.
Propagates notification that operations should be canceled.
The parameter values to be used to fill in parameters identified by '@' prefix in expression.
A object.
Provides strongly-typed access to each of the column values in the specified row.
Automatically applies type conversion to the column values.
A generic parameter that specifies the return type of the column.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
The value, of type T, of the specified by .
Provides strongly-typed access to each of the column values in the specified row.
Automatically applies type conversion to the column values.
A generic parameter that specifies the return type of the column.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
The value to be substituted if is retrieved.
The value, of type T, of the specified by .
Automatically applies type conversion to column values when only a type is available.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
Type of the column.
The value of the specified by .
Automatically applies type conversion to column values when only a type is available.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
Type of the column.
The value to be substituted if is retrieved.
The value of the specified by .
Provides strongly-typed access to each of the column values in the specified row.
Automatically applies type conversion to the column values.
A generic parameter that specifies the return type of the column.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
The value, of type T, of the specified by .
Parses a Guid from a database field that is a Guid type or a string representing a Guid.
The input , which acts as the instance for the extension method.
The name of the column to return the value of.
The value to be substituted if is retrieved; defaults to .
The value of the specified by .
Returns an of values from the .
The source to make async enumerable.
The source is null>.
An of values from the .
Returns a cancellable of values from the
and configures how awaits on the tasks returned from an async iteration will be performed.
The source to make async enumerable.
Propagates notification that operations should be canceled.
Whether to capture and marshal back to the current context.
The source is null>.
An of values from the .
Updates the underlying data of the using , and
returns the number of rows successfully updated.
The used to update the underlying data source.
The SQL statement used initially to populate the .
The to use for updating the underlying data source.
The number of rows successfully updated from the .
Takes the object and populates it with the given parameters.
The whose parameters are to be populated.
The first parameter value to populate the parameters with.
The remaining parameter values to populate the parameters with.
Takes the object and populates it with the given parameters.
The whose parameters are to be populated.
The parameter values to populate the parameters with.
Takes the object and populates it with the given parameters.
The whose parameters are to be populated.
The DeriveParameters() implementation of the to use to populate parameters.
The parameter values to populate the parameters with.
Then type to be used.
Number of arguments in of this , identified by '@', do not match number of supplied parameter -or-
You have supplied more than parameters listed for the stored procedure.
Creates and adds an to the object with the specified .
to which parameter needs to be added.
Name of the to be added.
Value of the to be added.
for .
Creates and adds a new for each of the specified to the object.
to which parameters need to be added.
The SQL statement.
The values for the parameters of the in the order that they appear in the SQL statement.
This method does very rudimentary parsing of the SQL statement so parameter names should start with the '@'
character and should be surrounded by either spaces, parentheses, or commas.
Do not use the same parameter name twice in the expression so that each parameter, identified by '@', will
have a corresponding value.
The fully populated parameterized command.
Number of arguments in expression, identified by '@', do not match number of supplied parameter .
Creates and returns a parameterized . Parameter names are embedded in the SQL statement
passed as a parameter to this method.
The database connection.
The SQL statement.
The values for the parameters of the in the order that they appear in the SQL statement.
This method does very rudimentary parsing of the SQL statement so parameter names should start with the '@'
character and should be surrounded by either spaces, parentheses, or commas.
Do not use the same parameter name twice in the expression so that each parameter, identified by '@', will
have a corresponding value.
The fully populated parameterized command.
Number of arguments in expression, identified by '@', do not match number of supplied parameter .
Gets any null parameter values as .
Source parameter values.
Parameter values with null replaced with .
Converts a delimited string into a .
The delimited text to be converted to .
The character(s) used for delimiting the text.
true, if the delimited text contains header information; otherwise, false.
A object.
Converts the to a multi-line delimited string (e.g., CSV export).
The whose data is to be converted to delimited text.
The character(s) to be used for delimiting the text.
true, if text is to be surrounded by quotes; otherwise, false.
true, if the delimited text should have header information.
A string of delimited text.
This class defines a common set of functionality that any data operation implementation can use
Table cleared event.
Bulk-insert executing event.
Bulk-insert completed event.
Bulk-insert exception event.
Disposed event.
Creates a new .
Creates a new .
Creates a new .
Get or set to attempt use of a BULK INSERT on a destination SQL Server connection
Get or set to force use of a BULK INSERT on a destination SQL Server connection regardless of whether or not it looks
like the referential integrity definition supports this.
This setting defines the SQL Server BULK INSERT settings that will be used if a BULK INSERT is performed.
This setting defines the text encoding that will be used when writing a temporary BULK INSERT file that will be needed
if a SQL Server BULK INSERT is performed - make sure the encoding output matches the specified CODEPAGE value in the
BulkInsertSettings property.
This setting defines the file path that will be used when writing a temporary BULK INSERT file that will be needed if a
SQL Server BULK INSERT is performed - make sure the destination SQL Server has rights to this path.
This specifies the string that will be substituted for the field terminator or row terminator if encountered in a database
value while creating a BULK INSERT file. The field terminator and row terminator values are defined in the BulkInsertSettings
property specified by the FIELDTERMINATOR and ROWTERMINATOR keywords respectively.
Set to True to clear all data from the destination database before processing data inserts.
Set to True to attempt use of a TRUNCATE TABLE on a destination SQL Server connection if ClearDestinationTables is True
and it looks like the referential integrity definition supports this. Your SQL Server connection will need the rights
to perform this operation.
Set to True to force use of a TRUNCATE TABLE on a destination SQL Server connection if ClearDestinationTables is True regardless
of whether or not it looks like the referential integrity definition supports this. Your SQL Server connection will need the
rights to perform this operation
Set to True to preserve primary key value data to the destination database before processing data inserts.
Close
Execute this
Clear destination schema table
schema table
Execute a command to insert or update data from source to destination table
Source table
Destination table
Lookup referential value for source table and update their information
Equality comparer for objects.
Determines whether the specified objects are equal.
true if the specified objects are equal; otherwise, false.
The first object of type to compare.
The second object of type to compare.
Returns a hash code for the specified object.
A hash code for the specified object.
The for which a hash code is to be returned.
The type of is a reference type and is null.
Default instance of the class.
Data types available to a object.
Boolean data type, .
Unsigned 8-bit byte data type, .
16-bit character data type, .
Date/time data type, .
Decimal data type, .
64-bit double precision floating point numeric data type, .
Unsigned 128-bit Guid integer data type, .
Signed 16-bit integer data type, .
Signed 32-bit integer data type, .
Signed 64-bit integer data type,
Signed byte data type, .
32-bit single precision floating point numeric data type, .
Character array data type, .
Time-span data type, .
Unsigned 16-bit integer data type, .
Unsigned 32-bit integer data type, .
Unsigned 64-bit integer data type, .
Unsigned byte array data type.
User defined/other data type.
Defines extension functions related to instances.
Serializes a to a destination .
to serialize.
to serialize on.
Flag to determine if unknown column types should be serialized as strings.
Flag to determine if extra information should be serialized to support null values.
Deserializes a from a .
to deserialize from.
Attempts to derive based on object .
of object to test.
Derived based on object if matched; otherwise .
Flag to determine if unknown column types should be serialized as strings.
Gets column object from given .
to derive object from.
Object derived from given .
This class defines a common set of functionality that any data operation implementation can use
Disposed event.
Creates a new .
Creates a new .
Creates a new .
Close
Execute this
Execute a command to update data from source to destination table
Source table
Destination table
Statement types for amendment application.
Apply amendment to all SELECT statements, i.e., , and .
Apply amendment to SELECT COUNT statements.
Apply amendment to SELECT statements that can return multiple rows of data.
Apply amendment to SELECT statements that will return a single row of data.
Apply amendment to INSERT statements.
Apply amendment to UPDATE statements.
Apply amendment to DELETE statements.
Target expressions for amendment application.
Apply amendment to table name.
Apply amendment to full field list.
Locations for target expression amendment application.
Apply amendment to beginning of .
Apply amendment to ending of .
Defines an attribute that will request amendment of a table name or field list with the specified text.
As an example, this can be used to add table hints, e.g., WITH (NOLOCK), for select statements in
SQL Server.
Applying the to a modeled table with no specified database type parameter
will be meant to infer that the amendment be used for all database types. Using a specific database type as a
parameter to the attribute, e.g., [AmendExpression("WITH (NOLOCK)", DatabaseType.SQLServer)], means the
amendment text will only be applied to the specific database - however, the attribute allows multiple instances
on the same identifier so you could specify that amendment application only be applied to two databases:
[AmendExpression("AS T1", DatabaseType.SQLServer), AmendExpression("AS T1", DatabaseType.MySQL)]
Other parameters exist to fully customize target expression, set affix position and specify statement types:
[AmendExpression("TOP 200",
TargetExpression = TargetExpression.FieldList,
AffixPosition = AffixPosition.Prefix,
StatementTypes = StatementTypes.SelectSet)]
Gets or sets amendment text to be applied.
Gets or sets target expression for amendment application; defaults to .
Gets or sets location for amendment application; defaults to .
Gets or sets statement types for amendment application; defaults to .
Gets target for amendment application.
When value is null, amendment text will be applied to all database types.
Creates a new that will request application of
for any database.
Amendment text to apply.
Creates a new that will request application of
for the specified .
Amendment text to apply.
Target for amendment text.
Type field.
Value field.
Description field.
Created on field.
Created by field.
Updated on field.
Updated by field.
Name field.
Created on field.
Created by field.
Updated on field.
Updated by field.
ClaimGroupID field.
AssignedClaimID field.
Created on field.
Created by field.
Updated on field.
Updated by field.
Defines an attribute that will mark a modeled table static function as a method to create a
to secure query functions for a modeled .
The static function should be a part of the modeled class, and have the footprint
MethodName( [])
Defines claims which will be checked for parameter values
Creates a new parameterized with the specified claims.
Claims to use for parameter values. The order of parameters is in the same order as claims, grabbing as many values as each claim provides
Defines an attribute that will allow a default sort field in the model
Gets field name to use for property.
Creates a new .
Direction of sort
Defines an attribute that will allow setting DELETE function roles for a modeled table.
Gets field name to use for property.
Creates a new .
Comma separated string of roles allowed for DELETE functions.
Defines an attribute that provides encryption of text field contents for a modeled table.
Application of attribute is only valid on properties; attribute will be
ignored if applied to properties of other types.
Default key reference value.
Gets reference name used to lookup encryption key and initialization vector;
new keys will be created for reference if it does not exist.
Creates a new .
Creates a new with a specified value.
Reference name used to lookup encryption key and initialization vector.
Defines an attribute that will mark a class as a JSON construct in
the property name.
Gets the EventType name to use in the database.
Creates a new .
Name to use for database entry.
Defines an interface that marks a class as a JSON construct in
the property name.
Defines an attribute that will mark a field as excluded from being processed
by non-primary field record restrictions.
Base class for Attributes that are used to extend the functionality of .
The regular expression used to match field names the attribute applies to.
Creates a new
Field match expression for the attribute.
Defines an attribute that will request use of a specific data type on a modeled table field.
Typically only needed to enforce use of a specific for parameters.
Applying this attribute to a modeled table field with no database type parameter will specify that
the field data type be used for all database types. Using a specific database type as a parameter
to the attribute, e.g., [FieldDataType(DbType.DateTime2, DatabaseType.SQLServer)], means the field
data type will only be applied to the specific database - however, the attribute allows multiple
instances on the same identifier so you could specify different field data types for different
database types. When multiple instances of the attribute are applied to the same identifier, the
first attribute encountered that does not target a specific database will be considered the default
value for all non-specified database types.
Gets field data type that determines which should be used when using
database command operations.
Gets target for this .
When value is null, specified will be applied to all database types.
Creates a new that will request use of specific .
Specific to target for field.
Creates a new that will request use of specific
for the specified .
Specific to target for field.
Target for applying .
Defines an attribute that will allow a custom field name for a modeled table instead of using
the property name.
Gets field name to use for property.
Creates a new .
Field name to use for property.
Defines an attribute that will allow setting GET function roles for a modeled table.
Gets field name to use for property.
Creates a new .
Comma separated string of roles allowed for GET functions.
Defines an interface for a filter that can be applied to queries.
For backend restrictions should be used. This interface
is intended to be used for user initiated searches and filters from a UI.
Gets or sets the name of the field to be searched.
Gets or sets the value to be searched.
Gets or sets the operator to be used for the search.
The list of supported operators includes:
- =
- ]]>
- ]]>
- IN
- NOT IN
- LIKE
- NOT LIKE
- =]]>
Attempted to assign an operator that is not supported.
Indicates whether this will work on encrypted fields.
The of the model that this applies to.
This will return null if the is not associated with a property.
Generates a that corresponds to this .
The that will be used to generate the restriction.
Defines a common interface for implementations of .
Gets instance associated with this used for database operations.
Gets the table name defined for the modeled table, includes any escaping as defined in model.
Gets the table name defined for the modeled table without any escape characters.
A table name will only be escaped if the model requested escaping with the .
Gets the wildcard character used for pattern matching within queries.
Gets flag that determines if modeled table has a primary key that is an identity field.
Gets or sets delegate used to handle table operation exceptions.
When exception handler is provided, table operations will not throw exceptions for database calls, any
encountered exceptions will be passed to handler for processing. Otherwise, exceptions will be thrown
on the call stack.
Gets or sets flag that determines if field names should be treated as case-sensitive. Defaults to false.
In cases where modeled table fields have applied , this flag will be used
to properly update escaped field names that may be case-sensitive. For example, escaped field names in Oracle
are case-sensitive. This value is typically false.
Gets or sets primary key cache.
The overloads that include paging parameters
cache the sorted and filtered primary keys of queried records between calls so that paging is fast and
efficient. Since the primary keys are cached, an instance of the should
exist per user session when using query functions that support pagination. In web based implementations,
the primary cache should be stored with user session state data and then restored between instances of
the that are created along with a connection that is opened per page.
The function should be called to manually clear cache when table
contents are known to have changed. Note that calls to any overload
will automatically clear any existing primary key cache.
Primary keys values are stored in data table without interpretation, i.e., in their raw form as queried
from the database. Primary key data in cache will be encrypted for models with primary key fields that
are marked with the
Gets or sets root record restriction that applies to query table operations.
Defining a root query restriction creates a base query filter that gets applied to all query operations,
even when another restriction is applied - in this case the root restriction will be pre-pended to the
specified query, e.g.:
restriction = RootQueryRestriction + restriction;
A root query restriction is useful to apply a common state to the query operations, e.g., always
filtering records for a specific user or context.
A root query restriction can be manually assigned to a instance or
automatically assigned by marking a model with the .
If any of the reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets or sets flag that determines if should be applied to update operations.
If only references primary key fields, then this property value should be set
to false since default update operations for a modeled record already work against primary key fields.
This flag can be manually set per instance or handled automatically by marking
a model with the and assigning a value to the attribute property
.
Gets or sets flag that determines if should be applied to delete operations.
If only references primary key fields, then this property value should be set
to false since default delete operations for a modeled record already work against primary key fields.
This flag can be manually set per instance or handled automatically by marking
a model with the and assigning a value to the attribute property
.
Creates a new modeled record instance, applying any modeled default values as specified by a
or on the
model properties.
New modeled record instance with any defined default values applied.
Applies the default values on the specified modeled table
where any of the properties are marked with either
or .
Record to update.
Applies the update values on the specified modeled table where
any of the properties are marked with .
Record to update.
Queries database and returns a single modeled table record for the specified .
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified .
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns modeled table records for the specified parameters.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified parameters.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Record restriction to apply.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Record restriction to apply.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Gets total record count for the modeled table.
Total record count for the modeled table.
Gets total record count for the modeled table.
Propagates notification that operations should be canceled.
Total record count for the modeled table.
Gets the record count for the modeled table based on search parameter.
Search executed against fields modeled with .
to be filtered by
Record count for the modeled table based on search parameter.
This is a convenience call to where restriction
is generated by
Gets the record count for the modeled table based on search parameter.
Search executed against fields modeled with .
Propagates notification that operations should be canceled.
to be filtered by
Record count for the modeled table based on search parameter.
This is a convenience call to where restriction
is generated by
Gets the record count for the specified - or - total record
count for the modeled table if is null.
Record restrictions to apply, if any.
Record count for the specified - or - total record count
for the modeled table if no is provided.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets the record count for the specified - or - total record
count for the modeled table if is null.
Propagates notification that operations should be canceled.
Record restrictions to apply, if any.
Record count for the specified - or - total record count
for the modeled table if no is provided.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets the record count for the modeled table for the specified SQL filter expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Record count for the modeled table for the specified parameters.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Gets the record count for the modeled table for the specified SQL filter expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Record count for the modeled table for the specified parameters.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Locally searches retrieved table records after queried from database for the specified sorting and search parameters.
Search executed against fields modeled with .
Function only typically used for record models that apply the .
Field name to order-by.
Sort ascending flag; set to false for descending.
to use when searching string fields; defaults to ordinal ignore case.
Record Filters to be applied.
An array of modeled table row instances for the queried records that match the search.
This function searches records locally after query from database, this way Search functionality will work
even with fields that are modeled with the and use restrictions not being = or =/=.
Primary keys for this function will not be cached server-side and this function will be slower and more expensive than similar calls
to . Usage should be restricted to cases searching for field data that has
been modeled with the .
This function does not paginate records, instead a full list of search records is returned. User can cache returned records and page
through them using the function. As a result, usage should be restricted to smaller data sets.
Locally searches retrieved table records after queried from database for the specified sorting and search parameters.
Search executed against fields modeled with .
Function only typically used for record models that apply the .
Field name to order-by.
Sort ascending flag; set to false for descending.
Propagates notification that operations should be canceled.
to use when searching string fields; defaults to ordinal ignore case.
Record Filters to be applied.
An array of modeled table row instances for the queried records that match the search.
This function searches records locally after query from database, this way Search functionality will work
even with fields that are modeled with the and use restrictions not being = or =/=.
Primary keys for this function will not be cached server-side and this function will be slower and more expensive than similar calls
to . Usage should be restricted to cases searching for field data that has
been modeled with the .
This function does not paginate records, instead a full list of search records is returned. User can cache returned records and page
through them using the function. As a result, usage should be restricted to smaller data sets.
Gets the specified of records from the provided source array.
Source records array.
Desired page of records.
Desired page size.
A page of records.
Gets the specified of records from the provided source array.
Source records array.
Desired page of records.
Desired page size.
A page of records.
Creates a new modeled table record queried from the specified .
Primary keys values of the record to load.
New modeled table record queried from the specified .
Creates a new modeled table record queried from the specified .
Propagates notification that operations should be canceled.
Primary keys values of the record to load.
New modeled table record queried from the specified .
Creates a new modeled table record queried from the specified .
of queried data to be loaded.
New modeled table record queried from the specified .
Converts the given collection of into a .
The collection of records to be inserted into the data table.
A data table containing data from the given records.
Converts the given collection of into a .
Propagates notification that operations should be canceled.
The collection of records to be inserted into the data table.
A data table containing data from the given records.
Deletes the record referenced by the specified .
Primary keys values of the record to load.
Number of rows affected.
Deletes the record referenced by the specified .
Propagates notification that operations should be canceled.
Primary keys values of the record to load.
Number of rows affected.
Deletes the specified modeled table from the database.
Record to delete.
Number of rows affected.
Deletes the specified modeled table from the database.
Record to delete.
Propagates notification that operations should be canceled.
Number of rows affected.
Deletes the record referenced by the specified .
of queried data to be deleted.
Number of rows affected.
Deletes the record referenced by the specified .
of queried data to be deleted.
Propagates notification that operations should be canceled.
Number of rows affected.
Deletes the records referenced by the specified .
Record restriction to apply
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
cannot be null.
Deletes the records referenced by the specified .
Record restriction to apply
Propagates notification that operations should be canceled.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
cannot be null.
Deletes the records referenced by the specified SQL filter expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Deletes the records referenced by the specified SQL filter expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Record to update.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Record to update.
Propagates notification that operations should be canceled.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified , any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
of queried data to be updated.
Record restriction to apply, if any.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified , any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
of queried data to be updated.
Propagates notification that operations should be canceled.
Record restriction to apply, if any.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified referenced by the
specified SQL filter expression and parameters, any model properties marked with
will be evaluated and applied before
the record is provided to the data source.
of queried data to be updated.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified referenced by the
specified SQL filter expression and parameters, any model properties marked with
will be evaluated and applied before
the record is provided to the data source.
of queried data to be updated.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Adds the specified modeled table to the database.
Record to add.
Number of rows affected.
Adds the specified modeled table to the database.
Record to add.
Propagates notification that operations should be canceled.
Number of rows affected.
Adds the specified to the database.
of queried data to be added.
Number of rows affected.
Adds the specified to the database.
of queried data to be added.
Propagates notification that operations should be canceled.
Number of rows affected.
Adds the specified modeled table to the database if the
record has not defined any of its primary key values; otherwise, the database will
be updated with the specified modeled table .
Record to add or update.
Number of rows affected.
Adds the specified modeled table to the database if the
record has not defined any of its primary key values; otherwise, the database will
be updated with the specified modeled table .
Record to add or update.
Propagates notification that operations should be canceled.
Number of rows affected.
Gets the primary key values from the specified .
Record of data to retrieve primary keys from.
Primary key values from the specified .
Gets the primary key values from the specified .
of queried data.
Primary key values from the specified .
Function returns raw data from without interpretation, it may be
necessary to call for models with primary key
fields that are marked with either or
.
Gets a record restriction based on the non-primary key values of the specified .
Record to retrieve non-primary key field values from.
Optional additional field names to exclude from the restriction.
Record restriction based on the non-primary key values of the specified .
This will look up a newly added record when the primary key values are not yet defined searching all field values.
If all fields do not represent a unique record, queries based on this restriction will return multiple records.
Note that if the modeled table has fields that are known be unique, searching based on those fields is preferred.
Any field modeled with will automatically be excluded from the restriction. The
parameter can be used to specify additional fields to exclude from the restriction.
Gets the field names for the table; if is true, also includes any escaping as defined in model.
Flag that determines if field names should include any escaping as defined in the model; defaults to true.
Array of field names.
A field name will only be escaped if the model requested escaping with the .
Get the non-primary key field names for the table; if is true, also includes any escaping as defined in model.
Flag that determines if field names should include any escaping as defined in the model; defaults to true.
Array of non-primary field names.
A field name will only be escaped if the model requested escaping with the .
Get the primary key field names for the table; if is true, also includes any escaping as defined in model.
Flag that determines if field names should include any escaping as defined in the model; defaults to true.
Array of primary key field names.
A field name will only be escaped if the model requested escaping with the .
Attempts to get the specified for a field.
Type of attribute to attempt to get.
Name of field to use for attribute lookup.
Attribute that was found, if any.
true if attribute was found; otherwise, false.
Attempts to get the specified for a field.
Name of field to use for attribute lookup.
Type of attribute to attempt to get.
Attribute that was found, if any.
true if attribute was found; otherwise, false.
is not an .
Determines if the specified field has an associated attribute.
Type of attribute to search for.
Name of field to use for attribute lookup.
true if field has attribute; otherwise, false.
Determines if the specified field has an associated attribute.
Name of field to use for attribute lookup.
Type of attribute to search for.
true if field has attribute; otherwise, false.
is not an .
Gets the value for the specified field.
Modeled table record.
Field name to retrieve.
Field value or null if field is not found.
Gets the interpreted value for the specified field, encrypting or returning any intermediate
value as needed.
Field name to retrieve.
Field value to use.
Interpreted value for the specified field, encrypting or returning any intermediate value
as needed.
This function will need to be used when calling overloads that take a or composite format
filter expression where the or have been modeled
on a field referenced by one of the parameters. Since the record restrictions are used
with a free-form expression, the class cannot be aware of the fields accessed in the
expression without attempting to parse the expression which would be time-consuming and error-prone; as a result, users
will need to be aware to call this function when using record restriction that references fields that are either marked
for encryption or use a specific field data-type attribute.
If a parameter references a field that is modeled with an ,
this function will need to be called, replacing the restriction parameter with the returned value, so that the field data
value will be properly encrypted prior to executing the database function.
If a parameter references a field that is modeled with a ,
this function will need to be called, replacing the restriction parameter with the returned value, so that the field data
type will be properly set prior to executing the database function.
Gets the for the specified field.
Field name to retrieve.
Field or null if field is not found.
Gets flag that determines if the specified field exists.
Field name to check.
true if field is found; otherwise, false.
Generates a based on .
to search.
based on fields marked with , Property Names and specified .
Any fields marked with will be automatically managed, i.e.,
the returned parameters will already apply any field based encryption as needed. Database query functions
executed for fields marked for encryption will only be searched using = and =/= , regardless of any otherwise
specified value in the as encryption is handled locally. However, the function
can be used to find data in encrypted fields that are marked for search with other limits.
Calculates the size of the current primary key cache, in number of records.
Number of records in the current primary key cache.
Clears the primary key cache for this instance.
This method is intended to be used in conjunction with calls to the overloads for
which are
used for record pagination.
If record set is known to have changed outside purview of this class, this method
should be called so that primary key cache can be reloaded.
Model for a matching claim from an authorization provider.
Type field.
Value field.
Description of the Type used for UI labeling
Description of the Value used for UI labeling
ID of the AuthenticationProvider
Created on field.
Created by field.
Updated on field.
Updated by field.
Contains classes and attributes used for model based database access.
Defines an attribute that will mark a property to not be serialized as a record field.
Defines an attribute that will allow a top number of results to be returned when queried
Gets field name to use for property.
Creates a new .
Number of top records to return per Page.
Defines an attribute that will allow a foreign key in the model to point back to parent table
Gets field name to use for property.
Creates a new .
Type of modeled table that key points back to.
Defines an attribute that will allow setting PATCH function roles for a modeled table.
Gets field name to use for property.
Creates a new .
Comma separated string of roles allowed for PATCH functions.
Defines an attribute that will allow setting POST function roles for a modeled table.
Gets field name to use for property.
Creates a new .
Comma separated string of roles allowed for POST functions.
Defines an attribute that will mark a property as a primary key field for a modeled table.
Gets flag that determines if primary key field is an identity field.
Creates a new .
is assumed to be false.
Creates a new with specified identity state.
Flag that determines if this primary key field is an identity field.
MatchingClaimID field.
ClaimGroupID field.
Created on field.
Created by field.
Updated on field.
Updated by field.
Defines a filter that can be applied to queries.
For backend restrictions should be used. This class
is intended to be used for user initiated searches and filters in the user interface.
Gets the collection of supported wildcard operators.
Record operations for modeled tables.
Operation for getting record count.
Operation for retrieving paged records.
Operation for deleting records.
Delete rights should be derived from methods marked with this operation.
Operation for creating a new record, i.e., instantiating a new modeled table record instance.
Operation for adding records.
Add rights should be derived from methods marked with this operation.
Operation for updating records.
Update rights should be derived from methods marked with this operation.
Defines an attribute that marks a method as a specific for a modeled table.
Gets or sets of modeled table.
Gets or sets the method represents.
Creates a new
The of modeled table.
The the method represents.
Defines a parameterized record restriction that can be applied to queries.
For versatility, values in the array are mutable, however, this makes the
array vulnerable to unintended updates for long-lived instances. Consequently, the normal use-case
of record restriction instances should be considered temporal. If an instance needs to be cached,
consider use of the function to reduce risk of unintended array updates.
Defines filter SQL expression for restriction as a composite format string - does not
include WHERE. When escaping is needed for field names, use standard ANSI quotes.
Each indexed parameter, e.g., "{0}", in the composite format string will be converted into
query parameters where each of the corresponding values in the
collection will be applied as values to an executed
query.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
Defines restriction parameter values.
If any of the reference a table field that is modeled with either an
or , then the function
will need to be called, replacing the
target parameter with the returned value so that the field value will be properly set prior
to executing any database function.
Creates a new parameterized with the specified SQL filter
expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the reference a table field that is modeled with either
an or , then the function
will need to be called, replacing the
target parameter with the returned value so that the field value will be properly set prior to
executing any database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
Gets or sets field value for the specified .
Index into field array.
field value for the specified .
Creates a deep copy of this record restriction.
Deep copy of this record restriction.
Determines whether the specified object is equal to the current object.
An object to compare with this object.
true if the current object is equal to the parameter; otherwise, false.
Indicates whether the current object is equal to another object of the same type.
An object to compare with this object.
true if the current object is equal to the parameter; otherwise, false.
Serves as the default hash function.
A hash code for the current .
Implicitly converts a based filter expression into a .
Operand.
Record operation representing the specified filter expression.
Compares to record restrictions for equality.
left operand.
right operand.
true if record restrictions are equal; otherwise, false.
Compares to record restrictions for inequality.
left operand.
right operand.
true if record restrictions are not equal; otherwise, false.
Combines two record restrictions with an AND condition.
left operand.
right operand.
New combined record restriction.
If both parameters are null, result will be null. If one parameter is null
and the other parameter is not, the non-null parameter will be returned. Equally, if the
of both parameters are null, empty or only whitespace,
then the result will be null. If one parameter has a filter expression that is
null, empty or whitespace and the other parameter's filter expression is defined, then
the parameter that has a filter expression will be returned.
Combines two record restrictions with an AND condition.
left operand.
right operand.
New combined record restriction.
If both parameters are null, result will be null. If one parameter is null
and the other parameter is not, the non-null parameter will be returned. Equally, if the
of both parameters are null, empty or only whitespace,
then the result will be null. If one parameter has a filter expression that is
null, empty or whitespace and the other parameter's filter expression is defined, then
the parameter that has a filter expression will be returned.
Combines two record restrictions with an OR condition.
left operand.
right operand.
New combined record restriction.
If both parameters are null, result will be null. If one parameter is null
and the other parameter is not, the non-null parameter will be returned. Equally, if the
of both parameters are null, empty or only whitespace,
then the result will be null. If one parameter has a filter expression that is
null, empty or whitespace and the other parameter's filter expression is defined, then
the parameter that has a filter expression will be returned.
Creates a deep copy of the record restriction.
Record restriction to clone.
Deep copy of the record restriction.
Combines two record restrictions with an AND condition.
Left operand.
Right operand.
New combined record restriction.
If both parameters are null, result will be null. If one parameter is null
and the other parameter is not, the non-null parameter will be returned. Equally, if the
of both parameters are null, empty or only whitespace,
then the result will be null. If one parameter has a filter expression that is
null, empty or whitespace and the other parameter's filter expression is defined, then
the parameter that has a filter expression will be returned.
Combines two record restrictions with an OR condition.
Left operand.
Right operand.
New combined record restriction.
If both parameters are null, result will be null. If one parameter is null
and the other parameter is not, the non-null parameter will be returned. Equally, if the
of both parameters are null, empty or only whitespace,
then the result will be null. If one parameter has a filter expression that is
null, empty or whitespace and the other parameter's filter expression is defined, then
the parameter that has a filter expression will be returned.
Defines an attribute that will mark a modeled table with a record restriction that applies
to all query functions for modeled .
Defines filter SQL expression for restriction as a composite format string - does not
include WHERE. When escaping is needed for field names, use standard ANSI quotes.
Each indexed parameter, e.g., "{0}", in the composite format string will be converted into
query parameters where each of the corresponding values in the
collection will be applied as values to an executed
query.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
Defines restriction parameter values.
Gets or sets flag that determines if root query restriction should be applied to update operations.
If root query restriction only references primary key fields, then this property value should
be set to false since default update operations for a modeled record already work against
primary key fields.
Gets or sets flag that determines if root query restriction should be applied to delete operations.
If root query restriction only references primary key fields, then this property value should
be set to false since default delete operations for a modeled record already work against
primary key fields.
Creates a new parameterized with the specified
SQL filter expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
Defines an attribute that will mark additional fields in the database as searchable field.
All modeled fields are automatically searchable so this only applies to fields that are not modeled.
Defines an attribute that will mark additional fields in the database as searchable field.
All modeled fields are automatically searchable so this only applies to fields that are not modeled.
The field names that are searchable.
Defines an attribute that marks static methods on a model that are used to transform
into .
Defines an attribute that marks static methods on a model that are used to transform
into .
A wrapper class for
Modeled table.
Creates a new
table operation which to wrap calls of.
Creates a new
db to create secure operations to.
which performs DB operations.
Gets instance associated with this used for database operations.
Gets the table name defined for the modeled table, includes any escaping as defined in model.
Gets the table name defined for the modeled table without any escape characters.
A table name will only be escaped if the model requested escaping with the .
Gets the wildcard character used for pattern matching within queries.
Gets flag that determines if modeled table has a primary key that is an identity field.
Gets or sets delegate used to handle table operation exceptions.
When exception handler is provided, table operations will not throw exceptions for database calls, any
encountered exceptions will be passed to handler for processing. Otherwise, exceptions will be thrown
on the call stack.
Gets or sets flag that determines if field names should be treated as case-sensitive. Defaults to false.
In cases where modeled table fields have applied , this flag will be used
to properly update escaped field names that may be case-sensitive. For example, escaped field names in Oracle
are case-sensitive. This value is typically false.
Gets or sets primary key cache.
The overloads that include paging parameters
cache the sorted and filtered primary keys of queried records between calls so that paging is fast and
efficient. Since the primary keys are cached, an instance of the should
exist per user session when using query functions that support pagination. In web based implementations,
the primary cache should be stored with user session state data and then restored between instances of
the that are created along with a connection that is opened per page.
The function should be called to manually clear cache when table
contents are known to have changed. Note that calls to any overload
will automatically clear any existing primary key cache.
Primary keys values are stored in data table without interpretation, i.e., in their raw form as queried
from the database. Primary key data in cache will be encrypted for models with primary key fields that
are marked with the
Gets or sets root record restriction that applies to query table operations.
Defining a root query restriction creates a base query filter that gets applied to all query operations,
even when another restriction is applied - in this case the root restriction will be pre-pended to the
specified query, e.g.:
restriction = RootQueryRestriction + restriction;
A root query restriction is useful to apply a common state to the query operations, e.g., always
filtering records for a specific user or context.
A root query restriction can be manually assigned to a instance or
automatically assigned by marking a model with the .
If any of the reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets or sets flag that determines if should be applied to update operations.
If only references primary key fields, then this property value should be set
to false since default update operations for a modeled record already work against primary key fields.
This flag can be manually set per instance or handled automatically by marking
a model with the and assigning a value to the attribute property
.
Gets or sets flag that determines if should be applied to delete operations.
If only references primary key fields, then this property value should be set
to false since default delete operations for a modeled record already work against primary key fields.
This flag can be manually set per instance or handled automatically by marking
a model with the and assigning a value to the attribute property
.
Creates a new modeled record instance, applying any modeled default values as specified by a
or on the
model properties.
New modeled record instance with any defined default values applied.
Transforms a into an equivalent , as defined by the model's .
Claims principal which is making the request.
Queries database and returns a single modeled table record for the specified .
Claims principal which is making the request.
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified .
Claims principal which is making the request.
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Claims principal which is making the request.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Claims principal which is making the request.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns modeled table records for the specified parameters.
Claims principal which is making the request.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified parameters.
Claims principal which is making the request.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Claims principal which is making the request.
Record restriction to apply.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Claims principal which is making the request.
Record restriction to apply.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting and paging parameters.
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Claims principal which is making the request.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Gets total record count for the modeled table.
Claims principal which is making the request.
Total record count for the modeled table.
Gets total record count for the modeled table.
Claims principal which is making the request.
Propagates notification that operations should be canceled.
Total record count for the modeled table.
Gets the record count for the modeled table based on search parameter.
Search executed against fields modeled with .
Claims principal which is making the request.
to be filtered by
Record count for the modeled table based on search parameter.
This is a convenience call to where restriction
is generated by
Gets the record count for the modeled table based on search parameter.
Search executed against fields modeled with .
Claims principal which is making the request.
Propagates notification that operations should be canceled.
to be filtered by
Record count for the modeled table based on search parameter.
This is a convenience call to where restriction
is generated by
Gets the record count for the specified - or - total record
count for the modeled table if is null.
Claims principal which is making the request.
Record restrictions to apply, if any.
Record count for the specified - or - total record count
for the modeled table if no is provided.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets the record count for the specified - or - total record
count for the modeled table if is null.
Claims principal which is making the request.
Propagates notification that operations should be canceled.
Record restrictions to apply, if any.
Record count for the specified - or - total record count
for the modeled table if no is provided.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Gets the record count for the modeled table for the specified SQL filter expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Record count for the modeled table for the specified parameters.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Gets the record count for the modeled table for the specified SQL filter expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Record count for the modeled table for the specified parameters.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Deletes the records referenced by the specified .
Claims principal which is making the request.
Record restriction to apply
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
cannot be null.
Deletes the records referenced by the specified .
Claims principal which is making the request.
Record restriction to apply
Propagates notification that operations should be canceled.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
cannot be null.
Deletes the specified modeled table from the database.
Claims principal which is making the request.
Record to delete.
Number of rows affected.
Deletes the specified modeled table from the database.
Claims principal which is making the request.
Record to delete.
Propagates notification that operations should be canceled.
Number of rows affected.
Deletes the records referenced by the specified SQL filter expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Deletes the records referenced by the specified SQL filter expression and parameters.
Claims principal which is making the request.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Claims principal which is making the request.
Record to update.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Claims principal which is making the request.
Record to update.
Propagates notification that operations should be canceled.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Claims principal which is making the request.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Claims principal which is making the request.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified , any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Claims principal which is making the request.
of queried data to be updated.
Record restriction to apply, if any.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified , any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Claims principal which is making the request.
of queried data to be updated.
Propagates notification that operations should be canceled.
Record restriction to apply, if any.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified referenced by the
specified SQL filter expression and parameters, any model properties marked with
will be evaluated and applied before
the record is provided to the data source.
Claims principal which is making the request.
of queried data to be updated.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified referenced by the
specified SQL filter expression and parameters, any model properties marked with
will be evaluated and applied before
the record is provided to the data source.
Claims principal which is making the request.
of queried data to be updated.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Defines an attribute that marks static methods on a model that are used to transform a
field into more complex order by expression, e.g., a subquery, for sorting.
Defines an attribute that marks static methods on a model that are used to transform a
field into more complex order by expression, e.g., a subquery, for sorting.
Defines an attribute that will allow a custom table name for a modeled table instead of using
the class name.
Gets field name to use for property.
Creates a new .
Table name to use for class.
Defines database operations for a modeled table.
Modeled table.
Creates a new .
instance to use for database operations.
Custom run-time tokens to apply to any modeled values.
cannot be null.
The can be used to apply run-time tokens to any defined values,
for example, given the following amendment expression applied to a modeled class:
[AmendExpression("TOP {count}",
TargetExpression = TargetExpression.FieldList,
AffixPosition = AffixPosition.Prefix,
StatementTypes = StatementTypes.SelectSet)]]
The key/value pairs could be set as follows at run-time:
int count = 200;
customTokens = new[] { new KeyValuePair<string, string>("{count}", $"{count}") };
Creates a new using provided .
instance to use for database operations.
Delegate to handle table operation exceptions.
Custom run-time tokens to apply to any modeled values.
When exception handler is provided, table operations will not throw exceptions for database calls, any
encountered exceptions will be passed to handler for processing.
The can be used to apply run-time tokens to any defined values,
for example, given the following amendment expression applied to a modeled class:
[AmendExpression("TOP {count}",
TargetExpression = TargetExpression.FieldList,
AffixPosition = AffixPosition.Prefix,
StatementTypes = StatementTypes.SelectSet)]]
The key/value pairs could be set as follows at run-time:
int count = 200;
customTokens = new[] { new KeyValuePair<string, string>("{count}", $"{count}") };
cannot be null.
Creates a new modeled record instance, applying any modeled default values as specified by a
or on the
model properties.
New modeled record instance with any defined default values applied.
Applies the default values on the specified modeled table
where any of the properties are marked with either
or .
Record to update.
Applies the update values on the specified modeled table where
any of the properties are marked with .
Record to update.
Queries database and returns a single modeled table record for the specified .
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified .
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified ,
execution of query will apply .
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply.
Propagates notification that operations should be canceled.
A single modeled table record for the queried record.
If no record is found for specified , null will be returned.
This is a convenience call to
specifying the parameter with a limit of 1 record.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns a single modeled table record for the specified SQL filter
expression and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
A single modeled table record for the queried record.
If no record is found for specified filter expression and parameters, null will be returned.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to
specifying the parameter with a limit of 1 record.
Queries database and returns modeled table records for the specified parameters.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified parameters.
Field name expression used for sort order, include ASC or DESC as needed - does not include ORDER BY; defaults to primary keys.
Record restriction to apply, if any.
Limit of number of record to return.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
If no record or is provided, all rows will be returned.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Record restriction to apply.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified .
Record restriction to apply.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This is a convenience call to only
specifying the parameter.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified SQL filter expression
and parameters.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
An enumerable of modeled table row instances for queried records.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to only
specifying the parameter.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting, paging and search parameters.
Search executed against fields modeled with .
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record Filters to be applied.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
This is a convenience call to where restriction
is generated by using .
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Queries database and returns modeled table records for the specified sorting and paging parameters.
Field name to order-by.
Sort ascending flag; set to false for descending.
Page number of records to return (1-based).
Current page size.
Propagates notification that operations should be canceled.
Record restrictions to apply, if any.
An enumerable of modeled table row instances for queried records.
This function is used for record paging. Primary keys are cached server-side, typically per user session,
to maintain desired per-page sort order. Call to manually clear cache
when table contents are known to have changed.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If the specified has been marked with ,
establishing the primary key cache operation will take longer to execute since query data will need to
be downloaded locally and decrypted so the proper sort order can be determined.
Locally searches retrieved table records after queried from database for the specified sorting and search parameters.
Search executed against fields modeled with .
Function only typically used for record models that apply the .
Field name to order-by.
Sort ascending flag; set to false for descending.
to use when searching string fields; defaults to ordinal ignore case.
Record Filters to be applied.
An array of modeled table row instances for the queried records that match the search.
This function searches records locally after query from database, this way Search functionality will work
even with fields that are modeled with the and use restrictions not being = or =/=.
Primary keys for this function will not be cached server-side and this function will be slower and more expensive than similar calls
to . Usage should be restricted to cases searching for field data that has
been modeled with the .
This function does not paginate records, instead a full list of search records is returned. User can cache returned records and page
through them using the function. As a result, usage should be restricted to smaller data sets.
Locally searches retrieved table records after queried from database for the specified sorting and search parameters.
Search executed against fields modeled with .
Function only typically used for record models that apply the .
Field name to order-by.
Sort ascending flag; set to false for descending.
Propagates notification that operations should be canceled.
to use when searching string fields; defaults to ordinal ignore case.
Record Filters to be applied.
An array of modeled table row instances for the queried records that match the search.
This function searches records locally after query from database, this way Search functionality will work
even with fields that are modeled with the and use restrictions not being = or =/=.
Primary keys for this function will not be cached server-side and this function will be slower and more expensive than similar calls
to . Usage should be restricted to cases searching for field data that has
been modeled with the .
This function does not paginate records, instead a full list of search records is returned. User can cache returned records and page
through them using the function. As a result, usage should be restricted to smaller data sets.
Gets the specified of records from the provided source array.
Source records array.
Desired page of records.
Desired page size.
A page of records.
Gets the specified of records from the provided source array.
Source records array.
Desired page of records.
Desired page size.
A page of records.
Creates a new modeled table record queried from the specified .
Primary keys values of the record to load.
New modeled table record queried from the specified .
Creates a new modeled table record queried from the specified .
Propagates notification that operations should be canceled.
Primary keys values of the record to load.
New modeled table record queried from the specified .
Creates a new modeled table record queried from the specified .
of queried data to be loaded.
New modeled table record queried from the specified .
Converts the given collection of into a .
The collection of records to be inserted into the data table.
A data table containing data from the given records.
Converts the given collection of into a .
Propagates notification that operations should be canceled.
The collection of records to be inserted into the data table.
A data table containing data from the given records.
Deletes the specified modeled table from the database.
Record to delete.
Number of rows affected.
Deletes the specified modeled table from the database.
Record to delete.
Propagates notification that operations should be canceled.
Number of rows affected.
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Record to update.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table ,
any model properties marked with will
be evaluated and applied before the record is provided to the data source.
Record to update.
Propagates notification that operations should be canceled.
Record restriction to apply, if any.
Flag that determines if any existing should be applied. Defaults to
setting.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
If any of the parameters reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Updates the database with the specified modeled table
referenced by the specified SQL filter expression and parameters, any model properties
marked with will be evaluated and applied
before the record is provided to the data source.
Record to update.
Filter SQL expression for restriction as a composite format string - does not include WHERE.
When escaping is needed for field names, use standard ANSI quotes.
Propagates notification that operations should be canceled.
Restriction parameter values.
Number of rows affected.
Record restriction is only used for custom update expressions or in cases where modeled
table has no defined primary keys.
Each indexed parameter, e.g., "{0}", in the composite format
will be converted into query parameters where each of the corresponding values in the
collection will be applied as
values to an executed query.
If any of the specified reference a table field that is modeled with
either an or , then the function
will need to be called, replacing the target parameter with the
returned value so that the field value will be properly set prior to executing the database function.
If needed, field names that are escaped with standard ANSI quotes in the filter expression
will be updated to reflect what is defined in the user model.
This is a convenience call to .
Adds the specified modeled table to the database.
Record to add.
Number of rows affected.
Adds the specified modeled table to the database.
Record to add.
Propagates notification that operations should be canceled.
Number of rows affected.
Adds the specified modeled table to the database if the
record has not defined any of its primary key values; otherwise, the database will
be updated with the specified modeled table .
Record to add or update.
Number of rows affected.
Adds the specified modeled table to the database if the
record has not defined any of its primary key values; otherwise, the database will
be updated with the specified modeled table .
Record to add or update.
Propagates notification that operations should be canceled.
Number of rows affected.
Gets the primary key values from the specified .
Record of data to retrieve primary keys from.
Primary key values from the specified .
Gets a record restriction based on the non-primary key values of the specified .
Record to retrieve non-primary key field values from.
Optional additional field names to exclude from the restriction.
Record restriction based on the non-primary key values of the specified .
This will look up a newly added record when the primary key values are not yet defined searching all field values.
If all fields do not represent a unique record, queries based on this restriction will return multiple records.
Note that if the modeled table has fields that are known be unique, searching based on those fields is preferred.
Any field modeled with will automatically be excluded from the restriction. The
parameter can be used to specify additional fields to exclude from the restriction.
Gets the value for the specified field.
Modeled table record.
Field name to retrieve.
Field value or null if field is not found.
Gets or sets instance used for evaluating encountered instances
of the on modeled table properties.
Accessing this property will create a unique type registry for the current type which
will initially contain the values found in the
and can be augmented with custom types. Set to null to restore use of the default type registry.
Gets a delegate for the function for specified type .
Delegate for the function.
This method is useful to deserialize a into a type instance
when no data connection is available, e.g., when using a deserialized .
Gets a delegate for the function for specified type .
Delegate for the function.
This method is useful to create a new type instance when no data connection
is available, applying any modeled default values as specified by a
or on the model properties.
Gets a delegate for the method for specified type .
Delegate for the method.
This method is useful to apply defaults values to an existing type instance when no data
connection is available, applying any modeled default values as specified by a
or on the model properties.
Gets a delegate for the method for specified type .
Delegate for the method.
This method is useful to apply update values to an existing type instance when no data
connection is available, applying any modeled update values as specified by instances of the
on the model properties.
Defines an attribute that will request use of the escaped name of a modeled identifier, i.e.,
a table or field name. Typically needed when identifier names are reserved SQL key words.
Applying [UseEscapedName] to a modeled table or field with no parameters will specify that an
escaped name be used for all database types. Using a specific database type as a parameter
to the attribute, e.g., [UseEscapedName(DatabaseType.SQLServer)], means the escaped name will
only be applied to the specific database - however, the attribute allows multiple instances
on the same identifier so you could specify that escaping only be applied to two databases,
for example: [UseEscapedName(DatabaseType.SQLServer), UseEscapedName(DatabaseType.MySQL)].
In the event multiple attributes have been applied to a modeled identifier where one instance
has specified no target database type and others have, the system will assume to target all
databases for escaping the name and ignore the specific targets.
Gets target for using escaped name.
When value is null, escaped name will be applied to all database types.
Gets or sets flag that determines if double quotes should be used as the identifier delimiter,
per SQL-99 standard, regardless of database type. Defaults to true except for MySQL.
If true, ANSI standard double-quotes will be used for escaping the identifier; otherwise,
the escaping identifier will be based on the connected database type.
Creates a new that will request use of escaped name for any database.
Creates a new that will request use of escaped name for the
specified .
Target for escaping identifier.
Defines a common model to hold a label and associated value.
Gets or sets the value property.
Gets or sets the label property.
The namespace organizes all Gemstone library functionality
related to database operations. The root data namespace also includes common data operations
classes, e.g., and .
Specifies the data type of a field, a property.
Copied from System.Data.OleDb.OleDbParameter in the .NET Framework.
No value (DBTYPE_EMPTY).
A 16-bit signed integer (DBTYPE_I2). This maps to .
A 32-bit signed integer (DBTYPE_I4). This maps to .
A floating-point number within the range of -3.40E +38 through 3.40E +38 (DBTYPE_R4). This maps to .
A floating-point number within the range of -1.79E +308 through 1.79E +308 (DBTYPE_R8). This maps to .
A currency value ranging from -2 63 (or -922,337,203,685,477.5808) to 2 63 -1 (or +922,337,203,685,477.5807) with an accuracy to a ten-thousandth of a currency unit (DBTYPE_CY). This maps to .
Date data, stored as a double (DBTYPE_DATE). The whole portion is the number of days since December 30, 1899, and the fractional portion is a fraction of a day. This maps to .
A null-terminated character string of Unicode characters (DBTYPE_BSTR). This maps to .
A pointer to an interface (DBTYPE_IDISPATCH). This maps to .
A 32-bit error code (DBTYPE_ERROR). This maps to .
A Boolean value (DBTYPE_BOOL). This maps to .
A special data type that can contain numeric, string, binary, or date data, and also the special values Empty and Null (DBTYPE_VARIANT). This type is assumed if no other is specified. This maps to .
A pointer to an interface (DBTYPE_UNKNOWN). This maps to .
A fixed precision and scale numeric value between -10 38 -1 and 10 38 -1 (DBTYPE_DECIMAL). This maps to .
A 8-bit signed integer (DBTYPE_I1). This maps to .
A 8-bit unsigned integer (DBTYPE_UI1). This maps to .
A 16-bit unsigned integer (DBTYPE_UI2). This maps to .
A 32-bit unsigned integer (DBTYPE_UI4). This maps to .
A 64-bit signed integer (DBTYPE_I8). This maps to .
A 64-bit unsigned integer (DBTYPE_UI8). This maps to .
A 64-bit unsigned integer representing the number of 100-nanosecond intervals since January 1, 1601 (DBTYPE_FILETIME). This maps to .
A globally unique identifier (or GUID) (DBTYPE_GUID). This maps to .
A stream of binary data (DBTYPE_BYTES). This maps to an of type .
A character string (DBTYPE_STR). This maps to .
A null-terminated stream of Unicode characters (DBTYPE_WSTR). This maps to .
An exact numeric value with a fixed precision and scale (DBTYPE_NUMERIC). This maps to .
Date data in the format yyyymmdd (DBTYPE_DBDATE). This maps to .
Time data in the format hhmmss (DBTYPE_DBTIME). This maps to .
Data and time data in the format yyyymmddhhmmss (DBTYPE_DBTIMESTAMP). This maps to .
An automation PROPVARIANT (DBTYPE_PROP_VARIANT). This maps to .
A variable-length numeric value ( only). This maps to .
A variable-length stream of non-Unicode characters ( only). This maps to .
A long string value ( only). This maps to .
A variable-length, null-terminated stream of Unicode characters ( only). This maps to .
A long null-terminated Unicode string value ( only). This maps to .
A variable-length stream of binary data ( only). This maps to an of type .
A long binary value ( only). This maps to an of type .
Specifies the type of object in database
Database object is DataTable
Database object is View
Database object is System Defined Table
Database object is System Defined View
Database object is Alias
Database object is Synonym
Database object is Global Temp
Database object is local Temp
Database object is Link
Database object is not defined
Specified the type of referential action on database object/Tables
Action Type is cascade
Action Type is to set null
Action Type is to set default
No Action
Represents a database field.
Creates a new .
Field name.
OLEDB data type for field.
Get Field Name
Get SQL escaped name of
Get Type
Get or set file ordinal
Get or set Allow Null flag
Get or set Auto increment flag
Get or set Auto increment seed
Get or set Auto increment step
Get or set has default value flag
Get or set default value
Get or set maximum length of field
Get or set numeric precision
Get or set Numeric scale
Get or set date time precision
Get or set read-only flag
Get or set for unique
Get or set description
Get or set auto increment translation
Get or set value of
Get or set flag to check is primary key or not
Get or set ordinal for Primary key field
Get or set primary key name
Get or set list of
Get or set - check is reference by
Get or set foreign key flag. if is then true else false
Get or set parent
Get or set 's parent
Compare ordinal to current field
Check type , if it is type of then compare to of else throw
Change value to encoded string. It will check and value before convert to compatible value
Gets the native value for the field (SQL Encoded).
Get information about referential action
check and return to appropriate .
Represents a database foreign key field.
Get foreign key parent information
Get or set Primary key field
Get or set Foreign key field
Get or set ordinal of
Get or set name of key
Get or set update rule for for
Get or set delete rule for for
Represents a collection of values.
Get or set field parent information
Get of Set Fields names to lookups
Get or set field indexes to lookups
Get the current index of foreign key field information
Get the current information by name
Get count of list
Get of field lists
Add a to list object
is type of
Get comma separated of
Represents a collection of values.
Get 's parent .
Get or set to fields lookup
Get or set Fields index lookup
Indexer property of Field
Indexer property of Field by Name
Get count of collection of
Add new to this collection.
Field to add.
Removes from the collection.
Field to remove.
Clears the field list.
Get type of list.
Get comma separated list of
Get type of list.
Get data table information for data processing
Creates a new .
Creates a new .
Creates a new .
Get or set list of for
Get or set name of
Get or set process flag
Get or set priority
Get or set identity SQL for
Get name of
Get SQL escaped name of
Get or set full name of
Get or set catalog information for
Get or set schema name
Get
Get or set description
Get row count in
Get parent information
Get of object
Check for object is view
Check for system tables and system views
Get flag for for temp
Get flag for alias or link
Get count for primary key
Get flag that determines if the table has any foreign keys.
Get flag of any foreign key
Gets flag that determines if the has an auto-increment field.
Gets auto-increment field for the , if any.
Get schema information flag based on
Gets display name for table.
Compare type of with object
Compare Table with other object
Check for reference flag, whether table has reference in another table
Check for direct table reference by .
Table to check for relation.
true if directly referenced; otherwise, false.
Checks for indirect table reference through .
Table to check for relation.
true if indirectly referenced; otherwise, false.
check for primary key field in
Check for
Re-evaluates identity SQL for database type.
Calculates row count.
List of collection
Gets table count.
Gets or sets parent .
Adds new table.
Table to add.
Removes table.
Table to remove.
Clears all tables.
Gets table at index.
Index of table
Table at index.
Gets table by name.
Table name.
Table with specified name.
Finds table by mapped named.
Mapped table name.
Table with mapped name.
Gets table enumerator.
Gets table field list.
Comma separated field list.
Check for referential order of
Default property of object
Allows tables to be sorted in proper referential integrity process object
First table to compare.
Second table to compare.
Compare foreign key comparison of tables
Get information about database schema
Defines a table filter that specifies no restrictions.
Creates a new .
Creates a new .
Get or set - information to process
OLEDB connection string to data source to analyze.
Set this value to restrict the types of tables returned in your schema. Table types can be OR'd together to create this table type restriction.
Set this value to False to keep the schema connection used during analysis open after analysis is complete.
Type of database specified in connect string.
Set this value to False to convert all Null values encountered in character fields to empty strings.
Set this value to False to convert all Null values encountered in numeric fields to zeros.
to open a database connection
Escapes a field or table name.
Name to escape.
Escaped .
Analyze data schema for processing data
Close
Opens an ADO connection.
ADO connection string.
Opened connection.
Opens an ADO connection.
ADO connection string.
Database type.
The deserialized schema.
Flag that determines if connection is ADO.
Opened connection.
Contains classes and attributes used for database schema migrations.
Defines an attribute that will mark a class as the target of a database schema migration.
In Gemstone, use this instead of the Fluent for consistent versioning.
Creates a new .
Branch number of the migration.
Year of the migration.
Month of the migration.
Day of the migration.
Author of the migration.
Gets the author of the migration.