[This is preliminary documentation and is subject to change.]
The RowsetBase type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | RowsetBase |
Creates an empty rowset
|
Methods
Name | Description | |
---|---|---|
![]() | Add |
Inserts a row
|
![]() | Check |
Checks argument for being non-null and of the same schema with this rowset
|
![]() | Clear |
Purges table
|
![]() | Compare |
Compares two rows
|
![]() | Contains | |
![]() | CopyTo | |
![]() | Delete( Object ) |
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
|
![]() | Delete(Row, IDataStoreKey) |
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
|
![]() | DeleteAll |
Deletes all rows from table. This method is similar to Purge() but does logging (when enabled)
|
![]() | DoDelete |
Tries to find a row with the same set of key fields in this table and if found, deletes it and returns its index, otherwise -1
|
![]() | DoInsert |
Tries to insert a row. If another row with the same set of key fields already in the table returns -1, otherwise
returns insertion index
|
![]() | DoUpdate |
Tries to find a row with the same set of key fields in this table and if found, replaces it and returns its index,
otherwise returns -1
|
![]() | DoUpsert |
Tries to find a row with the same set of key fields in this table and if found, replaces it and returns true,
otherwise inserts the row (if schemas match) and returns false. Optionally pass updateWhere condition
that may check whether update needs to be performed
|
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ![]() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from ![]() |
![]() | FindByKey( Object ) |
Tries to find a row by specified keyset and returns it or null if not found.
This method does not perform well on Rowsets instances as a rowset is unordered list which does linear search.
In contrast, Tables are always ordered and perform binary search instead
|
![]() | FindByKey(Row) |
Tries to find a row by specified keyset and returns it or null if not found
|
![]() | FindByKey(Row, Func Row, Boolean ) |
Tries to find a row by specified keyset and extra WHERE clause and returns it or null if not found.
This method does not perform well on Rowsets instances as a rowset is unordered list which does linear search.
In contrast, Tables are always ordered and perform binary search instead
|
![]() | FindByKey(Func Row, Boolean , Object ) |
Tries to find a row by specified keyset and extra WHERE clause and returns it or null if not found
|
![]() ![]() | FromJSON(String, Boolean, Boolean) |
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present
|
![]() ![]() | FromJSON(JSONDataMap, Boolean, Boolean) |
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present
|
![]() ![]() | FromJSON(JSONDataMap, Boolean , Boolean, Boolean, SetFieldFunc) |
Reads either Table or Rowset from JSON created by WriteAsJSON. Metadata must be present.
allMatched==false when some data did not match schema (i.e. too little fields or extra fields supplied)
|
![]() ![]() | FromJSON T (String, RowsetBase , SetFieldFunc) |
Reads either Table or Rowset from JSON created by WriteAsJSON.
|
![]() ![]() | FromJSON T (JSONDataMap, RowsetBase , SetFieldFunc) |
Reads either Table or Rowset from JSON created by WriteAsJSON.
|
![]() | GetChangeAt |
Retrievs a change by index or null if index is out of bounds or changes are not logged
|
![]() | GetEnumerator | |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | IndexOf | |
![]() | Insert(Row) |
Inserts the row. Returns insertion index
|
![]() | Insert(Int32, Row) |
Inserts row at index
|
![]() | KeyRowFromValues |
Creates key row out of field values for keys
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Purge |
Deletes all rows from table without logging the deleted modifications even when LogModifications=true
|
![]() | PurgeChanges |
Clears modifications accumulated by this instance
|
![]() | Remove |
Performs row delete
|
![]() | RemoveAt |
Deletes row
|
![]() | SearchForRow |
Provides rowsearching. Override to do binary search in sorted rowsets
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | Update |
Updates the row, Returns the row index or -1
|
![]() | Upsert |
Tries to find a row for update and if found, updates it and returns true,
otherwise inserts the row (if schemas match) and returns false. Optionally pass updateWhere condition
that may check whether update needs to be performed
|
![]() | Validate |
Validates all rows in this rowset.
Override to perform custom validations.
The method is not expected to throw exception in case of failed validation, rather return exception instance because
throwing exception really hampers validation performance when many rows need to be validated
|
![]() | WriteAsJSON |
Writes rowset as JSON including schema information. Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class
|
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | m_Changes | |
![]() | m_List | |
![]() | m_Schema |
Properties
Name | Description | |
---|---|---|
![]() | AsReadonlyIList |
Returns data as non-generic readonly IList
|
![]() | ChangeCount |
Returns a count of accumulated modifications performed on the rowset, or zero when no modifications have been made or
LogModifications = false
|
![]() | Changes |
Returns accumulated modifications performed on the rowset, or empty enumerator if no modifications have been made or
LogModifications = false
|
![]() | Context |
Provides dynamic view of rowset's data context - attributes applicable to the whole rowset
|
![]() | ContextMap |
Provides dynamic view as JSONDataMap of rowset's data context - attributes applicable to the whole rowset
|
![]() | Count |
Returns row count in this rowset
|
![]() | InstanceGUID |
Returns globaly-unique instance ID.
This ID is useful as a key for storing rowsets in object stores and posting data back from web client to server.
|
![]() | IsReadOnly | |
![]() | Item |
This method performs update on set
|
![]() | LogChanges |
Gets/Sets whether this rowset keeps track of all modifications done to it.
This property must be set to true to be able to save changes into ICRUDDataStore
|
![]() | Schema |
Returns a schema for rows that this rowset contains
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IEnumerable GetEnumerator |
See Also