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 = True; 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, TDAWhereExpression, string, Boolean, Boolean, TDAColumnMappingCollection, Boolean, TDAOrderByCollection, Integer, string, Boolean): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereExpression: TDAWhereExpression; aStatementName: string = ''; OpenIt: Boolean = False; AlwaysGenerateDynamicWhereStatement: Boolean = False; anUnionMapping: TDAColumnMappingCollection = nil; AllowAllFieldsInDynamicWhere: Boolean = False; aOrderBy: TDAOrderByCollection = nil; aMaxRecords: Integer = -1; aConnectionType: string = ''; aServerSideAccess: Boolean = True): IDADataset

Parameters:

  • aConnection: Connection
  • aName: Dataset name
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereExpression: Dynamic Where expression.
  • aStatementName: Statement name
  • OpenIt: Open created dataset
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • anUnionMapping: column mapping that used by union.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aOrderBy: collection of OrderBy statements.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: Connection type
  • aServerSideAccess: Allows access to private tables/fields

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

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aStatementName: string = ''; OpenIt: Boolean = False; aConnectionType: string = ''; aServerSideAccess: Boolean = True): IDADataset

Parameters:

  • aConnection: Connection
  • aName: Dataset name
  • aStatementName: Statement name
  • OpenIt: Open created dataset
  • aConnectionType: Connection type
  • aServerSideAccess: Allows access to private tables/fields

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, TDAWhereExpression, Boolean, string, Boolean, TDAOrderByCollection, Integer, string, Boolean): 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; aWhereExpression: TDAWhereExpression; OpenIt: Boolean = True; aStatementName: string = ''; AllowAllFieldsInDynamicWhere: Boolean = False; aOrderBy: TDAOrderByCollection = nil; aMaxRecords: Integer = -1; aConnectionType: string = ''; aServerSideAccess: Boolean = True): IDADataset

Parameters:

  • aConnection: Connection
  • aName: Dataset name
  • ParamNames: Parameter names
  • ParamValues: Parameter values
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereExpression: Dynamic Where expression.
  • OpenIt: Open created dataset
  • aStatementName: Statement name
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aOrderBy: collection of OrderBy statements.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: Connection type
  • aServerSideAccess: Allows access to private tables/fields

NewDataset (IDAConnection, string, array of string, array of Variant, Boolean, string, string, Boolean): 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 = True; aStatementName: string = ''; aConnectionType: string = ''; aServerSideAccess: Boolean = True): IDADataset

Parameters:

  • aConnection: Connection
  • aName: Dataset name
  • ParamNames: Parameter names
  • ParamValues: Parameter values
  • OpenIt: Open created dataset
  • aStatementName: Statement name
  • aConnectionType: Connection type
  • aServerSideAccess: Allows access to private tables/fields