Click or drag to resize

ITableOperations Interface

Defines a common interface for implementations of TableOperationsT.

Namespace: GSF.Data.Model
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public interface ITableOperations
View Source

The ITableOperations type exposes the following members.

Properties
 NameDescription
Public propertyApplyRootQueryRestrictionToDeletes Gets or sets flag that determines if RootQueryRestriction should be applied to delete operations.
Public propertyApplyRootQueryRestrictionToUpdates Gets or sets flag that determines if RootQueryRestriction should be applied to update operations.
Public propertyExceptionHandler Gets or sets delegate used to handle table operation exceptions.
Public propertyHasPrimaryKeyIdentityField Gets flag that determines if modeled table has a primary key that is an identity field.
Public propertyPrimaryKeyCache Gets or sets primary key cache.
Public propertyRootQueryRestriction Gets or sets root record restriction that applies to query table operations.
Public propertyTableName Gets the table name defined for the modeled table, includes any escaping as defined in model.
Public propertyUnescapedTableName Gets the table name defined for the modeled table without any escape characters.
Public propertyUseCaseSensitiveFieldNames Gets or sets flag that determines if field names should be treated as case sensitive. Defaults to false.
Top
Methods
 NameDescription
Public methodAddNewOrUpdateRecord Adds the specified modeled table record to the database if the record has not defined any of its primary key values; otherwise, the database will be updated with the specified modeled table record.
Public methodAddNewRecord(DataRow) Adds the specified row to the database.
Public methodAddNewRecord(Object) Adds the specified modeled table record to the database.
Public methodApplyRecordDefaults Applies the default values on the specified modeled table record where any of the properties are marked with either DefaultValueAttribute or DefaultValueExpressionAttribute.
Public methodApplyRecordUpdates Applies the update values on the specified modeled table record where any of the properties are marked with UpdateValueExpressionAttribute.
Public methodClearPrimaryKeyCache Clears the primary key cache for this ITableOperations instance.
Public methodDeleteRecord(DataRow) Deletes the record referenced by the specified row.
Public methodDeleteRecord(Object) Deletes the specified modeled table record from the database.
Public methodDeleteRecord(Object) Deletes the record referenced by the specified primaryKeys.
Public methodDeleteRecord(RecordRestriction, NullableBoolean) Deletes the records referenced by the specified restriction.
Public methodDeleteRecordWhere Deletes the records referenced by the specified SQL filter expression and parameters.
Public methodFieldHasAttribute(String, Type) Determines if the specified field has an associated attribute.
Public methodFieldHasAttributeTAttribute(String) Determines if the specified field has an associated attribute.
Public methodGetFieldNames Gets the field names for the table; if escaped is true, also includes any escaping as defined in model.
Public methodGetFieldType Gets the Type for the specified field.
Public methodGetFieldValue Gets the value for the specified field.
Public methodGetInterpretedFieldValue Gets the interpreted value for the specified field, encrypting or returning any intermediate IDbDataParameter value as needed.
Public methodGetPageOfRecords Gets the specified page of records from the provided source records array.
Public methodGetPrimaryKeyCacheSize Calculates the size of the current primary key cache, in number of records.
Public methodGetPrimaryKeyFieldNames Get the primary key field names for the table; if escaped is true, also includes any escaping as defined in model.
Public methodGetPrimaryKeys(DataRow) Gets the primary key values from the specified row.
Public methodGetPrimaryKeys(Object) Gets the primary key values from the specified record.
Public methodGetSearchRestriction Generates a RecordRestriction based on fields marked with SearchableAttribute and specified searchText.
Public methodIsSearchMatch(Object, String) Determines if any record fields modeled with the SearchableAttribute match any of the specified searchValues.
Public methodIsSearchMatch(Object, StringComparison, String) Determines if any record fields modeled with the SearchableAttribute match any of the specified searchValues.
Public methodLoadRecord(DataRow) Creates a new modeled table record queried from the specified row.
Public methodLoadRecord(Object) Creates a new modeled table record queried from the specified primaryKeys.
Public methodNewRecord Creates a new modeled record instance, applying any modeled default values as specified by a DefaultValueAttribute or DefaultValueExpressionAttribute on the model properties.
Public methodQueryRecord(RecordRestriction) Queries database and returns a single modeled table record for the specified restriction.
Public methodQueryRecord(String, RecordRestriction) Queries database and returns a single modeled table record for the specified restriction, execution of query will apply orderByExpression.
Public methodQueryRecordCount(RecordRestriction) Gets the record count for the specified restriction - or - total record count for the modeled table if restriction is null.
Public methodQueryRecordCount(String) Gets the record count for the modeled table based on search parameter. Search executed against fields modeled with SearchableAttribute.
Public methodQueryRecordCountWhere Gets the record count for the modeled table for the specified SQL filter expression and parameters.
Public methodQueryRecords(RecordRestriction) Queries database and returns modeled table records for the specified restriction.
Public methodQueryRecords(String, RecordRestriction, Int32) Queries database and returns modeled table records for the specified parameters.
Public methodQueryRecords(String, Boolean, Int32, Int32, RecordRestriction) Queries database and returns modeled table records for the specified sorting and paging parameters.
Public methodQueryRecords(String, Boolean, Int32, Int32, String) Queries database and returns modeled table records for the specified sorting, paging and search parameters. Search executed against fields modeled with SearchableAttribute.
Public methodQueryRecordsWhere Queries database and returns modeled table records for the specified SQL filter expression and parameters.
Public methodQueryRecordWhere Queries database and returns a single modeled table record for the specified SQL filter expression and parameters.
Public methodSearchRecords Locally searches retrieved table records after queried from database for the specified sorting and search parameters. Search executed against fields modeled with SearchableAttribute. Function only typically used for record models that apply the EncryptDataAttribute.
Public methodToDataTable Converts the given collection of records into a DataTable.
Public methodTryGetFieldAttribute(String, Type, Attribute) Attempts to get the specified attributeType for a field.
Public methodTryGetFieldAttributeTAttribute(String, TAttribute) Attempts to get the specified attribute for a field.
Public methodUpdateRecord(DataRow, RecordRestriction) Updates the database with the specified row, any model properties marked with UpdateValueExpressionAttribute will be evaluated and applied before the record is provided to the data source.
Public methodUpdateRecord(Object, RecordRestriction, NullableBoolean) Updates the database with the specified modeled table record, any model properties marked with UpdateValueExpressionAttribute will be evaluated and applied before the record is provided to the data source.
Public methodUpdateRecordWhere(DataRow, String, Object) Updates the database with the specified row referenced by the specified SQL filter expression and parameters, any model properties marked with UpdateValueExpressionAttribute will be evaluated and applied before the record is provided to the data source.
Public methodUpdateRecordWhere(Object, String, Object) Updates the database with the specified modeled table record referenced by the specified SQL filter expression and parameters, any model properties marked with UpdateValueExpressionAttribute will be evaluated and applied before the record is provided to the data source.
Top
See Also