DASqlProcessor Class

This is a Library topic for Data Abstract for .NET
This page is generated from external data, please do not update

Namespaces — Interfaces — Classes — Enums — Implements

Overview

The DASqlProcessor class is used by services inherited from DataAbstractService class to processes DA SQL queries.

DASqlProcessor can be added to the service's design pane as component or explicitly created in the service's constructor. Otherwise it will be automatically created during service activation.

Location

• Assembly: RemObjects.DataAbstract.Server.dll
• Namespace: RemObjects.DataAbstract.Server.Sql
• Ancestry: BaseComponent | DASqlProcessor

Properties

Service
The DA Service associated with DASqlProcessor Prism:   property Service: DataAbstractService read write C#:   DataAbstractService Service { get; set; } VB:   Property Service As DataAbstractService

Class Methods

InjectDynWhere
Insert a Dynamic Where expression into provided QueryExpression instance. Oxygene:   class method InjectDynWhere(query: QueryExpression; expression: WhereExpression) C#:   static void InjectDynWhere(QueryExpression query, WhereExpression expression) VB:   Shared Sub InjectDynWhere(query As QueryExpression, expression As WhereExpression) Parameters: query: expression:

Instance Methods

constructor ()
Creates a new instance of the DASqlProcessor class. Oxygene:   constructor C#:   constructor() VB:   Sub New
constructor (IContainer)
Creates a new instance of the DASqlProcessor class and adds it to the provided container. Oxygene:   constructor(aContainer: IContainer) C#:   constructor(IContainer aContainer) VB:   Sub New (aContainer As IContainer) Parameters: aContainer: Container for newly created DASqlProcessor instance.
GetData (String, String, array of DataParameter, DataStreamer)
Retrieves data from database using provided SQL query and query parameters. Then retrieved data are written in the data stream using provided DataStreamer instance. Written data table has name provided via aTableName parameter. Note that aSql query should reference Service Schema entities (i.e. tables and fields), not ones from underlying database(s). Oxygene:   method GetData(tableName: String; sql: String; parameters: array of DataParameter; streamer: DataStreamer) C#:   void GetData(String tableName, String sql, array of DataParameter parameters, DataStreamer streamer) VB:   Sub GetData(tableName As String, sql As String, parameters As array of DataParameter, streamer As DataStreamer) Parameters: tableName: sql: parameters: streamer:
GetData (String, String, WhereExpression, array of DataParameter, DataStreamer)
Oxygene:   method GetData(tableName: String; sql: String; additionalWhere: WhereExpression; parameters: array of DataParameter; streamer: DataStreamer) C#:   void GetData(String tableName, String sql, WhereExpression additionalWhere, array of DataParameter parameters, DataStreamer streamer) VB:   Sub GetData(tableName As String, sql As String, additionalWhere As WhereExpression, parameters As array of DataParameter, streamer As DataStreamer) Parameters: tableName: sql: additionalWhere: parameters: streamer:
GetData (String, String, WhereExpression, array of DataParameter, IAbstractConnection, ServiceSchema, D..)
Retrieves data from database using provided SQL query and query parameters. Then retrieved data are written in the data stream using provided DataStreamer instance. Written data table has name provided via aTableName parameter. Main difference between current method and GetData method is that the latter one uses instance defined in the Service property to retrieve needed Connection and Schema instances, while current method accepts IAbstractConnection and ServiceSchema instances as parameters. aAdditionalWhere parameter can be used for server-side filtering of the DA SQL query results. Query conditions represented by aAdditionalWhere are injected into the DA SQL query before it is executed. An obsolete method. It is recommended to use GetData instead. Oxygene:   method GetData(tableName: String; sql: String; additionalWhere: WhereExpression; parameters: array of DataParameter; connection: IAbstractConnection; serviceSchema: ServiceSchema; streamer: DataStreamer) C#:   void GetData(String tableName, String sql, WhereExpression additionalWhere, array of DataParameter parameters, IAbstractConnection connection, ServiceSchema serviceSchema, DataStreamer streamer) VB:   Sub GetData(tableName As String, sql As String, additionalWhere As WhereExpression, parameters As array of DataParameter, connection As IAbstractConnection, serviceSchema As ServiceSchema, streamer As DataStreamer) Parameters: tableName: sql: additionalWhere: parameters: connection: serviceSchema: streamer:
GetData (String, String, WhereExpression, array of DataParameter, IAbstractConnection, ServiceSchema, D..)
Oxygene:   method GetData(tableName: String; sql: String; additionalWhere: WhereExpression; parameters: array of DataParameter; connection: IAbstractConnection; serviceSchema: ServiceSchema; streamer: DataStreamer; maxRecords: Int32) C#:   void GetData(String tableName, String sql, WhereExpression additionalWhere, array of DataParameter parameters, IAbstractConnection connection, ServiceSchema serviceSchema, DataStreamer streamer, Int32 maxRecords) VB:   Sub GetData(tableName As String, sql As String, additionalWhere As WhereExpression, parameters As array of DataParameter, connection As IAbstractConnection, serviceSchema As ServiceSchema, streamer As DataStreamer, maxRecords As Int32) Parameters: tableName: sql: additionalWhere: parameters: connection: serviceSchema: streamer: maxRecords:

Events

BeforeExecutingGetDataReader
This event is fired before underlying data reader is executed and data is retrieved. Can be used for fine-adjusting of the data reader, query logging etc. Oxygene:   event BeforeExecutingGetDataReader: BeforeExecutingGetDataReaderEventHandler delegate: method Invoke(sender: ServiceSchema; e: BeforeExecutingGetDataReaderEventArgs) C#:   event BeforeExecutingGetDataReaderEventHandler BeforeExecutingGetDataReader delegate: void Invoke(ServiceSchema sender, BeforeExecutingGetDataReaderEventArgs e) VB:   Event BeforeExecutingGetDataReader As BeforeExecutingGetDataReaderEventHandler delegate: Sub Invoke(sender As ServiceSchema, e As BeforeExecutingGetDataReaderEventArgs)
BeforeGetTableData
Obsolete This legacy event is never fired and should not be used. It was left only for compatibility reasons. Oxygene:   event BeforeGetTableData: BeforeGetTableDataEventHandler delegate: method Invoke(e: BeforeGetTableDataEventArgs) C#:   event BeforeGetTableDataEventHandler BeforeGetTableData delegate: void Invoke(BeforeGetTableDataEventArgs e) VB:   Event BeforeGetTableData As BeforeGetTableDataEventHandler delegate: Sub Invoke(e As BeforeGetTableDataEventArgs)
SqlValidated
This event is fired after provided SQL query is validated. Oxygene:   event SqlValidated: SqlValidatedEventHandler delegate: method Invoke(sender: DASqlProcessor; e: SqlValidatedEventArgs) C#:   event SqlValidatedEventHandler SqlValidated delegate: void Invoke(DASqlProcessor sender, SqlValidatedEventArgs e) VB:   Event SqlValidated As SqlValidatedEventHandler delegate: Sub Invoke(sender As DASqlProcessor, e As SqlValidatedEventArgs)
ValidateTable
Obsolete This legacy event is never fired and should not be used. It was left only for compatibility reasons. Oxygene:   event ValidateTable: ValidateTableEventHandler delegate: method Invoke(e: ValidateTableEventArgs) C#:   event ValidateTableEventHandler ValidateTable delegate: void Invoke(ValidateTableEventArgs e) VB:   Event ValidateTable As ValidateTableEventHandler delegate: Sub Invoke(e As ValidateTableEventArgs)

See Also

• Lists
  • Data Abstract for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects Script for .NET:   Namespaces — Classes
  • Data Abstract shared:   Data Types – File Types
  • other editions:
    • Data Abstract for Xcode:   Protocols — Classes — Enums — Implements
    • Data Abstract for Delphi:   Interfaces — Classes — Enums — Aliases — Implements
    • Data Abstract for Java:   Namespaces — Interfaces — Classes — Enums — Implements
    • Data Abstract for JavaScript:   Objects

Product: RemObjects Data Abstract
Available Editions: Data Abstract for .NET, Delphi and Xcode

Glossary — Articles — Features — Library — Samples