[This is preliminary documentation and is subject to change.]
Interface for storage providers.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface Provider
Public Interface Provider
public interface class Provider
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | add_column(String, String, Type) |
Adds a column to an existing table.
|
| begin()()() |
Begin a transaction. Nested transactions are not supported.
|
| commit()()() |
Commit a transaction in progress.
|
| define_index(String, String, array<String>[]()[], Boolean) |
Create a named index for a given table.
|
| define_index(String, String, List<(Of <(String>)>), Boolean) |
Create a named index for a given table.
|
| define_link_table(String, List<(Of <(NameTypePair>)>), String, String, String) |
Create a link table with at least the two fields 'owner' and 'owned'. Additional fields
are named 'owned_0', 'owned_1' and so on.
|
| define_set_null(String, String, String) |
Defines a set null rule, to be applied, when a referenced item in the right table
gets deleted.
|
| define_table(String, array<NameTypePair>[]()[]) |
Create a table from the given params.
|
| define_table(String, List<(Of <(NameTypePair>)>), Boolean) |
Create a table from the given params.
|
| delete(Guid, String) |
Delete an instance from its table.
|
| delete_relation_item(String, Guid, Object) |
Delete a link between instances. This does never delete the associated instances themself.
|
| drop_column(String, String) |
Removes a column from a table.
|
| drop_index(String, String) |
Removes an index from a table.
|
| execute_schema_command(String) |
Executes and registers the given command as part of schema maintenance.
|
| finalize()()() |
Shuts down the Provider.
|
| initialize(Boolean) |
Initializes the provider. If it is advised to not create the schema and it
could not be found, the provider has to raise an error.
|
| insert(String, array<NameValuePair>[]()[]) |
Insert data into a table.
|
| insert(String, List<(Of <(NameValuePair>)>)) |
Insert data into a table.
|
| modify_column(String, String, Type) |
Modifies the type of an existing column.
|
 | name |
Identifier for the provider.
|
| rollback()()() |
Rollback a transaction in progress.
|
| schema()()() |
Queries the provider for the list of commands needed to reconstruct
the whole storage schema to its current state.
|
| schema(List<(Of <(String>)>)) |
Updates a storage schema from a list of commands
|
| schema_info |
Retrieve a complete description of the storage
|
| select(Guid, TypeSchema) |
Retrieves data for a single instance from the storage.
|
| select(TypeSchema, Constraint, Order) |
Selects data for multiple instances of a given schema.
|
| select(String, array<NameValuePair>[]()[]) |
Selects raw data from a specific table.
|
| select_into(TypeSchema, ObjectModel, Constraint, Order) |
Adds data for multiple instances conforming to a given schema to a given Model.
|
| select_into(TypeSchema, ObjectModel, Guid, String, array<String>[]()[]) |
This method is designed to fetch data for 1-n and m-n relations from the storage.
All entries owned by p_id are fetched.
|
| select_into(String, ObjectModel) |
Select data for a given type name.
|
| transaction_active()()() |
Checks wether a transaction is currently in progress.
|
| update(Guid, String, array<NameValuePair>[]()[]) |
Update the data within a table.
|
| update(Guid, String, List<(Of <(NameValuePair>)>)) |
Update the data within a table.
|