TDAClientSchema

Overview

The TDAClientSchema component represents the complete or partial schema of your database, including the data tables and commands defined for it, as well as relationships between data tables.

While you can edit the contents of a schema from code or in Object Inspector using the Commands, Datasets, Relationships and UpdateRules collection properties, you will usually edit your schema by double-clicking the component to launch Schema Modeler.

Location


 

constructor Create  override

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

Clear  override

Clears all properties.

procedure Clear

Commands

Provides access to the collection of all TDASQLCommands defined in the schema.

property Commands: TDASQLCommandCollection read write

Copy (TDAClientSchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

  • aSourceSchema: source schema.
  • DatasetNames: list of datasets.
  • CommandNames: list of commands.
  • UpdateRuleNames: list of update rules.
  • RelationShipNames: list of relationships.
  • UnionDataTablesNames: list of union datatables.
  • JoinDataTablesNames: list of join datatables.

Copy (TDAClientSchema, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)  overload

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

  • aSourceSchema: source schema.
  • IncludeDatasets: to copy datasets or not
  • IncludeCommands: to copy commands or not
  • IncludeUpdateRules: to copy update rules or not
  • IncludeRelationships: to copy relationships or not
  • IncludeUnionDataTables: to copy union datatables or not
  • IncludeJoinDataTables: to copy join datatables or not

CustomAttributes

Custom attributes of the schema.

property CustomAttributes: TStrings read write

Datasets

Holds a collection of all the TDADatasets (a.k.a. Data Tables) defined in the schema.

property Datasets: TDADatasetCollection read write

FindDataset

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

  • aDatasetName: given name.

GetDatasetCollectionClass  protected virtual

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

JoinDataTables

Holds a collection of all the TDAJoinDataTables defined in the schema.

property JoinDataTables: TDAJoinDataTableCollection read write

LoadFromFile (string)  overload    (declared in TDAStreamableComponent)

procedure LoadFromFile(const aFileName: string)

Parameters:

  • aFileName:

LoadFromFile (string, TDAPersistFormat)  overload    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

LoadFromJson    (declared in TDAStreamableComponent)

procedure LoadFromJson(aJson: ROUTF8String)

Parameters:

  • aJson:

LoadFromStream (TStream)  overload virtual    (declared in TDAStreamableComponent)

procedure LoadFromStream(aStream: TStream)

Parameters:

  • aStream:

LoadFromStream (TStream, TDAPersistFormat)  overload virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

LoadFromString    (declared in TDAStreamableComponent)

procedure LoadFromString(aValue: ROUTF8String)

Parameters:

  • aValue:

LoadFromXml    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

Namespace

Namespace

property Namespace: string read write

Notification  protected override    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

  • aComponent: component
  • Operation: operation

RelationShips

Maintains a collection of all the TDADatasetRelationships defined in the schema.

property RelationShips: TDADatasetRelationshipCollection read write

RestoreNonStreamableProperties  protected virtual    (declared in TDAStreamableComponent)

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

SaveNonStreamableProperties  protected virtual    (declared in TDAStreamableComponent)

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

SaveToStream  virtual    (declared in TDAStreamableComponent)

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

SendRemoveNotification  protected    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

UnionDataTables

Holds a collection of all the TDAUnionDataTables defined in the schema.

property UnionDataTables: TDAUnionDataTableCollection read write

UpdateRules

Provides access to the collection of all TDAUpdateRules defined in the schema.

property UpdateRules: TDAUpdateRuleCollection read write

Version

Version number of current schema.

property Version: Integer read write

 

Commands

Provides access to the collection of all TDASQLCommands defined in the schema.

property Commands: TDASQLCommandCollection read write

CustomAttributes

Custom attributes of the schema.

property CustomAttributes: TStrings read write

Datasets

Holds a collection of all the TDADatasets (a.k.a. Data Tables) defined in the schema.

property Datasets: TDADatasetCollection read write

JoinDataTables

Holds a collection of all the TDAJoinDataTables defined in the schema.

property JoinDataTables: TDAJoinDataTableCollection read write

Namespace

Namespace

property Namespace: string read write

RelationShips

Maintains a collection of all the TDADatasetRelationships defined in the schema.

property RelationShips: TDADatasetRelationshipCollection read write

UnionDataTables

Holds a collection of all the TDAUnionDataTables defined in the schema.

property UnionDataTables: TDAUnionDataTableCollection read write

UpdateRules

Provides access to the collection of all TDAUpdateRules defined in the schema.

property UpdateRules: TDAUpdateRuleCollection read write

Version

Version number of current schema.

property Version: Integer read write

 

constructor Create  override

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

Clear  override

Clears all properties.

procedure Clear

Copy (TDAClientSchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

  • aSourceSchema: source schema.
  • DatasetNames: list of datasets.
  • CommandNames: list of commands.
  • UpdateRuleNames: list of update rules.
  • RelationShipNames: list of relationships.
  • UnionDataTablesNames: list of union datatables.
  • JoinDataTablesNames: list of join datatables.

Copy (TDAClientSchema, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)  overload

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

  • aSourceSchema: source schema.
  • IncludeDatasets: to copy datasets or not
  • IncludeCommands: to copy commands or not
  • IncludeUpdateRules: to copy update rules or not
  • IncludeRelationships: to copy relationships or not
  • IncludeUnionDataTables: to copy union datatables or not
  • IncludeJoinDataTables: to copy join datatables or not

FindDataset

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

  • aDatasetName: given name.

GetDatasetCollectionClass  protected virtual

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

LoadFromFile (string)  overload    (declared in TDAStreamableComponent)

procedure LoadFromFile(const aFileName: string)

Parameters:

  • aFileName:

LoadFromFile (string, TDAPersistFormat)  overload    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

LoadFromJson    (declared in TDAStreamableComponent)

procedure LoadFromJson(aJson: ROUTF8String)

Parameters:

  • aJson:

LoadFromStream (TStream)  overload virtual    (declared in TDAStreamableComponent)

procedure LoadFromStream(aStream: TStream)

Parameters:

  • aStream:

LoadFromStream (TStream, TDAPersistFormat)  overload virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

LoadFromString    (declared in TDAStreamableComponent)

procedure LoadFromString(aValue: ROUTF8String)

Parameters:

  • aValue:

LoadFromXml    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

Notification  protected override    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

  • aComponent: component
  • Operation: operation

RestoreNonStreamableProperties  protected virtual    (declared in TDAStreamableComponent)

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

SaveNonStreamableProperties  protected virtual    (declared in TDAStreamableComponent)

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

SaveToStream  virtual    (declared in TDAStreamableComponent)

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

SendRemoveNotification  protected    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

  • aComponent: component