| Query Class |
The Query class provides methods to craft an individual query
against the database.
The typical pattern for using this class is through the 'Database'.
Typically it would not be initialised directly.
Note that this is a stub class that a driver will extend and complete as
required for individual database types. Individual drivers could add
additional methods, but this is discouraged to ensure that the API is the
same for all database types.
Inheritance HierarchySystemObject
DataTablesQuery
DataTables.DatabaseUtil.MysqlQuery
DataTables.DatabaseUtil.OracleQuery
DataTables.DatabaseUtil.PostgresQuery
DataTables.DatabaseUtil.SqliteQuery
DataTables.DatabaseUtil.SqlserverQuery
DataTablesQuery
DataTables.DatabaseUtil.MysqlQuery
DataTables.DatabaseUtil.OracleQuery
DataTables.DatabaseUtil.PostgresQuery
DataTables.DatabaseUtil.SqliteQuery
DataTables.DatabaseUtil.SqlserverQuery
Namespace: DataTables
Assembly: DataTables (in DataTables.dll) Version: 1.6.5.0 (1.6.5.0)
SyntaxC#
public abstract class Query
The Query type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Query |
Query instance construtor. Should be called by the Database
class methods rather than direction initialisation.
|
Methods| Name | Description | |
|---|---|---|
| _BuildField |
Create a comma separated field list
|
| _BuildJoin |
Create a JOIN satement list
|
| _BuildLimit |
Create the LIMIT / OFFSET string.
Default is to create a MySQL and Postgres style statement. Drivers can override
|
| _BuildOrder |
Create the ORDER BY statement
|
| _BuildSet |
Create a set list
|
| _BuildTable |
Create the table list
|
| _BuildValue |
Create a bind field balue list
|
| _BuildWhere |
Create the WHERE statement
|
| _Delete |
Execute a DELETE statement from the current configuration
|
| _Exec |
Execute the query. Provided by the driver
|
| _Insert |
Execute an INSERT statement from the current configuration
|
| _Prepare |
Prepare the SQL query by populating the bound variables. Provided by the driver
|
| _ProtectIdentifiers |
Protect field names
|
| _Raw |
Execute a given statement
|
| _SafeBind |
The characters that can be used to bind a value are quite limited. We need
to abstract this out to allow slightly more complex expressions including
dots for easy aliasing
|
| _Select |
Execute an SELECT statement from the current configuration
|
| _Update |
Execute a UPDATE statement from the current configuration
|
| _Where |
Add an individual where condition to the query
|
| _WhereGroup |
Add parentheses to a where condition
|
 | AndWhere(ActionQuery) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| AndWhere(DictionaryString, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| AndWhere(String, IEnumerableObject, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| AndWhere(String, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| Bind |
Bind a value for safe SQL execution
|
 | Commit |
Commit a transaction
|
| Distinct |
Set a distinct flag for a `select` query. Note that this has no
effect on any other query type.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exec |
Execute the setup query
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Get(IEnumerableString) |
Add one or more get (select) field
|
| Get(String) |
Add one or more get (select) field
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Init |
Method that can be used by the database driver to run commands on first connect
|
| Join |
Perform a JOIN operation
|
| Limit |
Limit the result set to a certain size
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Offset |
Offset the return set by a given number of records (useful for paging).
|
| Order(IEnumerableString) |
Order by
|
| Order(String) |
Order by
|
| OrWhere(ActionQuery) |
Where query - Bound to the previous condition (if there is one) as an OR statement
|
| OrWhere(DictionaryString, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an OR statement
|
| OrWhere(String, IEnumerableObject, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an OR statement
|
| OrWhere(String, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an OR statement
|
| Pkey |
Get the primary key column name(s) that have been set for an insert
|
| Pkey(String) |
Set the primary key column names for an insert, so the inserted value can be
retrieved in the result.
|
| Rollback |
Rollback the database state to the start of the transaction
|
| Set(DictionaryString, Object, Boolean) |
Set one or more fields to their given values
|
| Set(String, Object, Boolean) |
Set a single field to a given value
|
| Table(ListString) |
Set table(s) to perform the query on
|
| Table(String) |
Set table(s) to perform the query on
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Transaction |
Start a new transaction
|
| Where(ActionQuery) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| Where(DictionaryString, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| Where(String, IEnumerableObject, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| Where(String, Object, String, Boolean) |
Where query - Bound to the previous condition (if there is one) as an AND statement
|
| WhereGroup(Boolean, String) | Obsolete.
Provide grouping for WHERE conditions.
|
| WhereGroup(ActionQuery, String) |
Provide grouping for WHERE conditions.
|
See Also