DATA_Address
DATA_Address: TvxClientDataSet
Example
procedure ScriptEvent(var Value: variant);
begin
CreateData(DATA_Address, ['Code,string,100', 'ShipAddr1,string,100', 'ShipCity,string,100']);
DATA_Address.Append;
DATA_Address['Code'].AsString := 'ADDR-001';
DATA_Address['ShipCity'].AsString := 'Example City';
DATA_Address.Post;
Value := DATA_Address.RecordCount;
end;
Usage
DATA_Address provides the action-owned friendly dataset conventionally used for address working data.
Conventional VxData context
The current VxData schema has an Address table keyed by Num/Id, scoped by AppNum, with Code, shipping address components, optional suburb linkage, row hash and audit dates. Address_Map is a separate normalisation table. Querying either table, joining it, or selecting a subset of those columns is entirely the script/map author's responsibility.
That convention is guidance for choosing queries and field names, not a guarantee. A configured source/destination or customer extension may expose a different subset or additional columns. Use FindField for optional columns and never assume a named field merely because this page describes the current base schema.
Behaviour, lifecycle and side effects
- Velox loads all returned rows into memory and preserves fetched string whitespace. Large results can use substantial memory.
- Field access, navigation, filtering, indexing, inserts, edits, posts and deletes mutate this shared object. Closing or recreating it invalidates retained fields and record positions.
Postupdates the client dataset; it is not proof of an external database write or transaction commit. SQL/file effects belong to the function used to populate or persist it.- Data helper functions generally catch and log SQL/creation failures, potentially leaving the object inactive or reset. Direct invalid field, conversion or dataset-state operations can raise.
- Action cleanup closes every friendly dataset. Velox owns the object; never free it or depend on records surviving another action execution.
- The mutable dataset and cursor are not thread-safe. Do not hand the reference to asynchronous work or let nested code reposition it without an explicit contract.
Alias and naming cautions
The friendly suffix communicates intended use only. It does not validate record type, authenticate a party/application, enforce foreign keys or protect the dataset from being reused for unrelated data.
Additional Technical Info
DATA_Address is a friendly, action-owned dataset conventionally used for address lookup or transformation data. It is a live TvxClientDataSet reference; the friendly name does not load data, choose a connection, execute SQL or impose a field layout.
Runtime binding and identity
Velox constructs the object with the action and binds DATA_Address to TvxActionMan.FData39. Its diagnostic dataset name is DATA_Address.
The dataset begins inactive and without fields. CreateData, the Data query helpers and load methods can each replace its current schema/records. All scripts using this action see the same live cursor, filters, indexes and edits until the dataset is closed or repopulated.
Related entries
Datasetsexplains cursor, field, edit and ownership rules.CreateDatacreates an explicit in-memory schema.GetDataandGetDataFromDBexplicitly populate a dataset.TvxClientDataSetis the exposed class.DATA_Cityis a separate geographic working dataset.
External references
- Embarcadero DocWiki:
TClientDataSetdocuments the inherited Delphi in-memory dataset. - Embarcadero DocWiki:
TDataSetdocuments the inherited cursor/edit model. - Free Pascal:
TDataSetprovides compatibility context; Velox uses Delphi and its own descendant.