Skip to content

$Database

$Database allows you to perform relational database operations.

You can use the $Database.Get method to query existing records, make changes on the returned DataTable instance, and persist all changes with the DataTable.Save method.

If you need to just insert new values, you can use the $Database.Empty method to create an empty to add new rows and save the table.

This class also provides the $Database.ImportFromXml and $Database.ExportToXml methods to map the database to a Data Model (XML) to allow users to make interactive changes.

To update or insert a single row, you can use the $Database.EnsureData method to perform single-row updates with less code.

1
const $Database;

Capabilities

Data Modification

  • Database.AddData: Appends a new row to the specified target table and returns the inserted row as a DataRow object.
  • Database.DeleteData: Removes all rows from the specified table by using a column and value as a single criterion, and returns the number of rows deleted.
  • Database.EnsureData: Inserts or updates a row in the table based on the specified column and value as a single criterion. Only the included columns get updated.
  • Database.EnsureStoreData: Inserts or updates a row in the table based on the specified column and value as a single criterion. Only the included columns are updated.
  • Database.ExecuteNonQuery: Creates a connection to the relevant system with the information defined on the domain and runs the query. Returns the number of affected rows.

Import and Export

Queries and Retrieval

  • Database.ExecuteQuery: Creates a connection to the relevant system using the information defined on the domain and runs the query.
  • Database.Get: Executes the specified query and returns the results as a DataTable instance.
  • Database.GetData: Executes a query using the specified column and value as a single criterion, and returns the resulting DataTable instance.