From 3fb601d14354c867e1ead94b027c99c4a2fc15b5 Mon Sep 17 00:00:00 2001 From: vman Date: Wed, 16 Nov 2022 14:07:28 -0500 Subject: Add project files. --- .../VNLib.Plugins.Extensions.Data.xml | 473 +++++++++++++++++++++ 1 file changed, 473 insertions(+) create mode 100644 VNLib.Plugins.Extensions.Data/VNLib.Plugins.Extensions.Data.xml (limited to 'VNLib.Plugins.Extensions.Data/VNLib.Plugins.Extensions.Data.xml') diff --git a/VNLib.Plugins.Extensions.Data/VNLib.Plugins.Extensions.Data.xml b/VNLib.Plugins.Extensions.Data/VNLib.Plugins.Extensions.Data.xml new file mode 100644 index 0000000..638637d --- /dev/null +++ b/VNLib.Plugins.Extensions.Data/VNLib.Plugins.Extensions.Data.xml @@ -0,0 +1,473 @@ + + + + VNLib.Plugins.Extensions.Data + + + + + An abstraction that defines a Data-Store that supports + bulk data operations + + The data-model type + + + + Deletes a collection of records from the store + + A collection of records to delete + A task the resolves the number of entires removed from the store + + + + Updates a collection of records + + The collection of records to update + A task the resolves an error code (should evaluate to false on failure, and true on success) + + + + Creates a bulk collection of records as entries in the store + + The collection of records to add + A task the resolves an error code (should evaluate to false on failure, and true on success) + + + + Creates or updates individual records from a bulk collection of records + + The collection of records to add + A task the resolves an error code (should evaluate to false on failure, and true on success) + + + + An abstraction that defines a Data-Store and common + operations that retrieve or manipulate records of data + + The data-model type + + + + Gets the total number of records in the current store + + A task that resolves the number of records in the store + + + + Gets the number of records that belong to the specified constraint + + A specifier to constrain the reults + The number of records that belong to the specifier + + + + Gets a record from its key + + The key identifying the unique record + A promise that resolves the record identified by the specified key + + + + Gets a record from its key + + A variable length specifier arguemnt array for retreiving a single application + + + + + Gets a record from the store with a partial model, intended to complete the model + + The partial model used to query the store + A task the resolves the completed data-model + + + + Fills a collection with enires retireved from the store using the specifer + + The collection to add entires to + A specifier argument to constrain results + The maximum number of elements to retrieve + A Task the resolves to the number of items added to the collection + + + + Fills a collection with enires retireved from the store using a variable length specifier + parameter + + The collection to add entires to + The maximum number of elements to retrieve + + A Task the resolves to the number of items added to the collection + + + + Updates an entry in the store with the specified record + + The record to update + A task the resolves an error code (should evaluate to false on failure, and true on success) + + + + Creates a new entry in the store representing the specified record + + The record to add to the store + A task the resolves an error code (should evaluate to false on failure, and true on success) + + + + Deletes one or more entrires from the store matching the specified record + + The record to remove from the store + A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success) + + + + Deletes one or more entires from the store matching the specified unique key + + The unique key that identifies the record + A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success) + + + + Deletes one or more entires from the store matching the supplied specifiers + + A variable length array of specifiers used to delete one or more entires + A task the resolves the number of records removed(should evaluate to false on failure, and deleted count on success) + + + + Updates an entry in the store if it exists, or creates a new entry if one does not already exist + + The record to add to the store + A task the resolves the result of the operation + + + + Defines a Data-Store that can retirieve and manipulate paginated + data + + The data-model type + + + + Gets a collection of records using a pagination style query, and adds the records to the collecion + + The collection to add records to + Pagination page to get records from + The maximum number of items to retrieve from the store + A task that resolves the number of items added to the collection + + + + Gets a collection of records using a pagination style query with constraint arguments, and adds the records to the collecion + + The collection to add records to + Pagination page to get records from + The maximum number of items to retrieve from the store + A params array of strings to constrain the result set from the db + A task that resolves the number of items added to the collection + + + + Defines an entity base that has an owner, identified by its user-id + + + + + The user-id of the owner of the entity + + + + + Provides a base for DBSet Records with a timestamp/version + a unique ID key, and create/modified timestamps + + + + + + + + + + + + + + + + + Implements basic data-store functionality with abstract query builders + + A implemented type + + + + Gets a unique ID for a new record being added to the store + + + + + Gets a new ready for use + + + + + + An object rental for entity collections + + + + + + + + + + + + + + Builds a query that attempts to get a single entry from the + store based on the specified record if it does not have a + valid property + + The active context to query + The record to search for + A query that yields a single record if it exists in the store + + + + Builds a query that attempts to get a single entry from the + store to update based on the specified record + + The active context to query + The record to search for + A query that yields a single record to update if it exists in the store + + + + Updates the current record (if found) to the new record before + storing the updates. + + The new record to capture data from + The current record to be updated + + + + + + + + + + + + + Builds a query that results in a single entry to delete from the + constraint arguments + + The active context + A variable length parameter array of query constraints + A query that yields a single record (or no record) to delete + + + + + + + + + + Builds a query to get a count of records constrained by the specifier + + The active context to run the query on + The specifier constrain + A query that can be counted + + + + Builds a query to get a collection of records based on an variable length array of parameters + + The active context to run the query on + An arguments array to constrain the results of the query + A query that returns a collection of records from the store + + + + + + + + + + Builds a query to get a count of records constrained by the specifier + + The active context to run the query on + The specifier constrain + A query that can be counted + + + + + + + + + + + + + Builds a query to get a single record from the variable length parameter arguments + + The context to execute query against + Arguments to constrain the results of the query to a single record + A query that yields a single record + + + + + Builds a query to get a single record from the specified record. + + + Unless overridden, performs an ID based query for a single entry + + + The context to execute query against + A record to referrence the lookup + A query that yields a single record + + + + + + + + + + Builds a query to get a collection of records based on an variable length array of parameters + + The active context to run the query on + An arguments array to constrain the results of the query + A query that returns a paginated collection of records from the store + + + + Represents a basic data model for an EFCore entity + for support in data-stores + + + + + A unique id for the entity + + + + + The the entity was created in the store + + + + + The the entity was last modified in the store + + + + + Entity concurrency token + + + + + A data store that provides unique identities and protections based on an entity that has an owner + + + + + + + + Gets a single item contrained by a given user-id and item id + + + + + + + + + + + Updates the specified record within the store + + + The record to update + The userid of the record owner + A task that evaluates to the number of records modified + + + + Updates the specified record within the store + + + The record to update + The userid of the record owner + A task that evaluates to the number of records modified + + + + Gets a single entity from its ID and user-id + + + The unique id of the entity + The user's id that owns the resource + A task that resolves the entity or null if not found + + + + Deletes a single entiry by its ID only if it belongs to the speicifed user + + + The unique id of the entity + The user's id that owns the resource + A task the resolves the number of eneities deleted (should evaluate to true or false) + + + + + + + + + + + + + + The transaction that was opened on the current context + + + + + + + + Opens a single transaction on the current context. If a transaction is already open, + it is disposed and a new transaction is begun. + + + + + Invokes the on the current context + + + + + Invokes the on the current context + + + + + + + -- cgit