IDASchema

Overview

The IDASchema interface represents functions to work with commands and datasets in a custom Schema.

The TDASchema class, for example, implements the IDASchema interface to work with specified Schema commands and datasets.

Location

  • Unit: uDAServerInterfaces.pas
  • Ancestry: IDASchema


Required Methods

Clear

Clears the datasets and command s that are related to the current schema.

procedure Clear

GetCommandText

Returns the SQL statement for the specified command with the name aName.

function GetCommandText(const aConnection: IDAConnection; const aName: string): string

Parameters:

  • aConnection: Specified connection
  • aName: Name of the specified command

GetDatasetText

Returns the SQL statement for the specified dataset with the name aName.

function GetDatasetText(const aConnection: IDAConnection; const aName: string): string

Parameters:

  • aConnection: Specified connection
  • aName: Name of the specified dataset

MergeDataDictionaries

Returns true if the current dataset contains the related data dictionaries, otherwise returns false.

function MergeDataDictionaries: Boolean

NewCommand (IDAConnection, string, string, string): IDASQLCommand  overload

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

  • aConnection: Specified connection
  • aName: Specified command name
  • aStatementName: SQL statement that is associated with the new command
  • aConnectionType: connection type.

NewCommand (IDAConnection, string, array of string, array of Variant, Boolean, string, string): IDASQLCommand  overload

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; ExecuteIt: Boolean; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

  • aConnection: Specified connection
  • aName: Specified command name
  • ParamNames: parameter names
  • ParamValues: parameter values
  • ExecuteIt: executes created command
  • aStatementName: SQL statement that is associated with the new command
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, UnicodeString, string, Boolean, Boolean, Boolean, string, Boolean, Integer, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; aStatementName: string; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean; aSortColumnName: string; aSortAscMode: Boolean; aMaxRecords: Integer; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, string, Boolean, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aStatementName: string; OpenIt: Boolean; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, Boolean, string, Boolean, string, Boolean, Integer, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; aStatementName: string; AllowAllFieldsInDynamicWhere: Boolean; aSortColumnName: string; aSortAscMode: Boolean; aMaxRecords: Integer; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • ParamNames: parameter names.
  • ParamValues: parameter values.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • OpenIt: open created dataset.
  • aStatementName: statement name.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, Boolean, string, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; OpenIt: Boolean; aStatementName: string; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • ParamNames: parameter names.
  • ParamValues: parameter values.
  • OpenIt: open created dataset.
  • aStatementName: statement name.
  • aConnectionType: connection type.