C# Class Microsoft.Isam.Esent.Interop.Api

Perform atomic addition on one column. The column must be of type JET_coltyp.Long. This function allows multiple sessions to update the same record concurrently without conflicts.

This method wraps JetEscrowUpdate.

Add a new column to an existing table.

Attaches a database file for use with a database instance. In order to use the database, it will need to be subsequently opened with JetOpenDatabase.

Attaches a database file for use with a database instance. In order to use the database, it will need to be subsequently opened with JetOpenDatabase.

Performs a streaming backup of an instance, including all the attached databases, to a directory. With multiple backup methods supported by the engine, this is the simplest and most encapsulated function.

Initiates an external backup while the engine and database are online and active.

Initialize a new ESENT session.

Causes a session to enter a transaction or create a new save point in an existing transaction.

Causes a session to enter a transaction or create a new save point in an existing transaction.

Closes a database file that was previously opened with JetOpenDatabase or created with JetCreateDatabase.

Closes a file that was opened with JetOpenFileInstance after the data from that file has been extracted using JetReadFileInstance.

Close an open table.

Commits the changes made to the state of the database during the current save point and migrates them to the previous save point. If the outermost save point is committed then the changes made during that save point will be committed to the state of the database and the session will exit the transaction.

Makes a copy of an existing database. The copy is compacted to a state optimal for usage. Data in the copied data will be packed according to the measures chosen for the indexes at index create. In this way, compacted data may be stored as densely as possible. Alternatively, compacted data may reserve space for subsequent record growth or index insertions.

Walks each index of a table to exactly compute the number of entries in an index, and the number of distinct keys in an index. This information, together with the number of database pages allocated for an index and the current time of the computation is stored in index metadata in the database. This data can be subsequently retrieved with information operations.

Creates and attaches a database file.

Creates and attaches a database file with a maximum database size specified. JetAttachDatabase2.

Creates an index over data in an ESE database. An index can be used to locate specific data quickly.

Creates indexes over data in an ESE database.

When creating multiple indexes (i.e. with numIndexCreates greater than 1) this method MUST be called outside of any transactions and with exclusive access to the table. The JET_TABLEID returned by JetCreateTable will have exlusive access or the table can be opened for exclusive access by passing OpenTableGrbit.DenyRead to JetOpenTable.

Allocates a new instance of the database engine.

Allocate a new instance of the database engine for use in a single process, with a display name specified.

Create an empty table. The newly created table is opened exclusively.

Starts and stops database defragmentation tasks that improves data organization within a database.

Starts and stops database defragmentation tasks that improves data organization within a database.

The callback passed to JetDefragment2 can be executed asynchronously. The GC doesn't know that the unmanaged code has a reference to the callback so it is important to make sure the callback isn't collected.

Deletes the current record in a database table.

Deletes a column from a database table.

Deletes a column from a database table.

Deletes an index from a database table.

Deletes a table from a database.

Releases a database file that was previously attached to a database session.

Duplicates an open cursor and returns a handle to the duplicated cursor. If the cursor that was duplicated was a read-only cursor then the duplicated cursor is also a read-only cursor. Any state related to constructing a search key or updating a record is not copied into the duplicated cursor. In addition, the location of the original cursor is not duplicated into the duplicated cursor. The duplicated cursor is always opened on the clustered index and its location is always on the first row of the table.

Initialize a new ESE session in the same instance as the given sesid.

Ends an external backup session. This API is the last API in a series of APIs that must be called to execute a successful online (non-VSS based) backup.

Ends an external backup session. This API is the last API in a series of APIs that must be called to execute a successful online (non-VSS based) backup.

Ends a session.

Performs an atomic addition operation on one column. This function allows multiple sessions to update the same record concurrently without conflicts. Also see EscrowUpdate.

Frees memory that was allocated by a database engine call.

This method is internal because we never expose the memory allocated by ESENT to our callers.

Retrieves the bookmark for the record that is associated with the index entry at the current position of a cursor. This bookmark can then be used to reposition that cursor back to the same record using JetGotoBookmark. The bookmark will be no longer than SystemParameters.BookmarkMost bytes. Also see GetBookmark.

Retrieves information about a table column.

Retrieves information about all columns in a table.

Ddetermines the name of the current index of a given cursor. This name is also used to later re-select that index as the current index using JetSetCurrentIndex. It can also be used to discover the properties of that index using JetGetTableIndexInfo.

Retrieves information about indexes on a table.

Retrieves information about the instances that are running.

Enables the application to retrieve the context handle known as Local Storage that is associated with a cursor or the table associated with that cursor. This context handle must have been previously set using JetSetLS. JetGetLS can also be used to simultaneously fetch the current context handle for a cursor or table and reset that context handle.

Explicitly reserve the ability to update a row, write lock, or to explicitly prevent a row from being updated by any other session, read lock. Normally, row write locks are acquired implicitly as a result of updating rows. Read locks are usually not required because of record versioning. However, in some cases a transaction may desire to explicitly lock a row to enforce serialization, or to ensure that a subsequent operation will succeed.

Retrieves information about database objects.

Returns the fractional position of the current record in the current index in the form of a JET_RECPOS structure. Also see JetGotoPosition.

Retrieves record size information from the desired location.

Retrieves a special bookmark for the secondary index entry at the current position of a cursor. This bookmark can then be used to efficiently reposition that cursor back to the same index entry using JetGotoSecondaryIndexBookmark. This is most useful when repositioning on a secondary index that contains duplicate keys or that contains multiple index entries for the same record.

Gets database configuration options.

JET_param.ErrorToString passes in the error number in the paramValue, which is why it is a ref parameter and not an out parameter.

Retrieves information about a table column.

Retrieves information about a table column.

Retrieves information about all columns in the table.

Retrieves information about indexes on a table.

Positions a cursor to an index entry for the record that is associated with the specified bookmark. The bookmark can be used with any index defined over a table. The bookmark for a record can be retrieved using JetGetBookmark.

Moves a cursor to a new location that is a fraction of the way through the current index. Also see JetGetRecordPosition.

Positions a cursor to an index entry that is associated with the specified secondary index bookmark. The secondary index bookmark must be used with the same index over the same table from which it was originally retrieved. The secondary index bookmark for an index entry can be retrieved using JetGotoSecondaryIndexBookmark.

Extends the size of a database that is currently open.

Performs idle cleanup tasks or checks the version store status in ESE.

Counts the number of entries in the current index from the current position forward. The current position is included in the count. The count can be greater than the total number of records in the table if the current index is over a multi-valued column and instances of the column have multiple-values. If the table is empty, then 0 will be returned for the count.

Initialize the ESENT database engine.

Initialize the ESENT database engine.

Computes the intersection between multiple sets of index entries from different secondary indices over the same table. This operation is useful for finding the set of records in a table that match two or more criteria that can be expressed using index ranges. Also see IntersectIndexes.

Constructs search keys that may then be used by JetSeek and JetSetIndexRange.

The MakeKey functions provide datatype-specific make key functionality.

Navigate through an index. The cursor can be positioned at the start or end of the index and moved backwards and forwards by a specified number of index entries. Also see TryMoveFirst, TryMoveLast, TryMoveNext, TryMovePrevious.

Navigate through an index. The cursor can be positioned at the start or end of the index and moved backwards and forwards by a specified number of index entries. Also see TryMoveFirst, TryMoveLast, TryMoveNext, TryMovePrevious.

Starts a snapshot. While the snapshot is in progress, no write-to-disk activity by the engine can take place.

Begins the preparations for a snapshot session. A snapshot session is a short time interval in which the engine does not issue any write IOs to disk, so that the engine can participate in a volume snapshot session (when driven by a snapshot writer).

Notifies the engine that it can resume normal IO operations after a freeze period and a successful snapshot.

Opens a database previously attached with JetAttachDatabase, for use with a database session. This function can be called multiple times for the same database.

Opens an attached database, database patch file, or transaction log file of an active instance for the purpose of performing a streaming fuzzy backup. The data from these files can subsequently be read through the returned handle using JetReadFileInstance. The returned handle must be closed using JetCloseFileInstance. An external backup of the instance must have been previously initiated using JetBeginExternalBackupInstance.

Opens a cursor on a previously created table.

Creates a temporary table with a single index. A temporary table stores and retrieves records just like an ordinary table created using JetCreateTableColumnIndex. However, temporary tables are much faster than ordinary tables due to their volatile nature. They can also be used to very quickly sort and perform duplicate removal on record sets when accessed in a purely sequential manner. Also see Api.JetOpenTempTable2, Api.JetOpenTempTable3. VistaApi.JetOpenTemporaryTable.

Creates a temporary table with a single index. A temporary table stores and retrieves records just like an ordinary table created using JetCreateTableColumnIndex. However, temporary tables are much faster than ordinary tables due to their volatile nature. They can also be used to very quickly sort and perform duplicate removal on record sets when accessed in a purely sequential manner. Also see Api.JetOpenTempTable, Api.JetOpenTempTable3. VistaApi.JetOpenTemporaryTable.

Creates a temporary table with a single index. A temporary table stores and retrieves records just like an ordinary table created using JetCreateTableColumnIndex. However, temporary tables are much faster than ordinary tables due to their volatile nature. They can also be used to very quickly sort and perform duplicate removal on record sets when accessed in a purely sequential manner. Also see Api.JetOpenTempTable, Api.JetOpenTempTable2, VistaApi.JetOpenTemporaryTable.

Prepare a cursor for update.

Retrieves the contents of a file opened with Api.JetOpenFileInstance.

Allows the application to configure the database engine to issue notifications to the application for specific events. These notifications are associated with a specific table and remain in effect only until the instance containing the table is shut down using JetTerm.

Changes the name of an existing column.

Changes the name of an existing table.

Disassociates a session from the current thread. This should be used in conjunction with JetSetSessionContext.

Notifies the database engine that the application is no longer scanning the entire index the cursor is positioned on. This call reverses a notification sent by JetSetTableSequential.

Restores and recovers a streaming backup of an instance including all the attached databases. It is designed to work with a backup created with the Api.JetBackupInstance function. This is the simplest and most encapsulated restore function.

Retrieves a single column value from the current record. The record is that record associated with the index entry at the current position of the cursor. Alternatively, this function can retrieve a column from a record being created in the cursor copy buffer. This function can also retrieve column data from an index entry that references the current record. In addition to retrieving the actual column value, JetRetrieveColumn can also be used to retrieve the size of a column, before retrieving the column data itself so that application buffers can be sized appropriately.

The RetrieveColumnAs functions provide datatype-specific retrieval functions.

Retrieves multiple column values from the current record in a single operation. An array of JET_RETRIEVECOLUMN structures is used to describe the set of column values to be retrieved, and to describe output buffers for each column value to be retrieved.

Retrieves the key for the index entry at the current position of a cursor. Also see RetrieveKey.

Undoes the changes made to the state of the database and returns to the last save point. JetRollback will also close any cursors opened during the save point. If the outermost save point is undone, the session will exit the transaction.

Efficiently positions a cursor to an index entry that matches the search criteria specified by the search key in that cursor and the specified inequality. A search key must have been previously constructed using JetMakeKey(JET_SESID,JET_TABLEID,byte[],int,MakeKeyGrbit). Also see TrySeek.

The JetSetColumn function modifies a single column value in a modified record to be inserted or to update the current record. It can overwrite an existing value, add a new value to a sequence of values in a multi-valued column, remove a value from a sequence of values in a multi-valued column, or update all or part of a long value (a column of type JET_coltyp.LongText or JET_coltyp.LongBinary).

The SetColumn methods provide datatype-specific overrides which may be more efficient.

Changes the default value of an existing column.

Allows an application to set multiple column values in a single operation. An array of JET_SETCOLUMN structures is used to describe the set of column values to be set, and to describe input buffers for each column value to be set.

Set the current index of a cursor.

Set the current index of a cursor.

Set the current index of a cursor.

Sets the size of an unopened database file.

Temporarily limits the set of index entries that the cursor can walk using JetMove(JET_SESID,JET_TABLEID,int,MoveGrbit) to those starting from the current index entry and ending at the index entry that matches the search criteria specified by the search key in that cursor and the specified bound criteria. A search key must have been previously constructed using JetMakeKey(JET_SESID,JET_TABLEID,byte[],int,MakeKeyGrbit). Also see TrySetIndexRange.

Enables the application to associate a context handle known as Local Storage with a cursor or the table associated with that cursor. This context handle can be used by the application to store auxiliary data that is associated with a cursor or table. The application is later notified using a runtime callback when the context handle must be released. This makes it possible to associate dynamically allocated state with a cursor or table.

Associates a session with the current thread using the given context handle. This association overrides the default engine requirement that a transaction for a given session must occur entirely on the same thread. Use JetResetSessionContext to remove the association.

Sets database configuration options.

Sets database configuration options.

Notifies the database engine that the application is scanning the entire index that the cursor is positioned on. Consequently, the methods that are used to access the index data will be tuned to make this scenario as fast as possible. Also see JetResetTableSequential.

Prevents streaming backup-related activity from continuing on a specific running instance, thus ending the streaming backup in a predictable way.

Prepares an instance for termination.

Terminate an instance that was created with JetInit or JetCreateInstance.

Terminate an instance that was created with JetInit or JetCreateInstance.

Used during a backup initiated by JetBeginExternalBackup to delete any transaction log files that will no longer be needed once the current backup completes successfully.

Configures the database engine to stop issuing notifications to the application as previously requested through JetRegisterCallback.

The JetUpdate function performs an update operation including inserting a new row into a table or updating an existing row. Deleting a table row is performed by calling JetDelete.

JetUpdate is the final step in performing an insert or an update. The update is begun by calling JetPrepareUpdate and then by calling JetSetColumn(JET_SESID,JET_TABLEID,JET_COLUMNID,byte[],int,SetColumnGrbit,JET_SETINFO) one or more times to set the record state. Finally, JetUpdate(JET_SESID,JET_TABLEID,byte[],int,out int) is called to complete the update operation. Indexes are updated only by JetUpdate or and not during JetSetColumn.

The JetUpdate function performs an update operation including inserting a new row into a table or updating an existing row. Deleting a table row is performed by calling JetDelete.

JetUpdate is the final step in performing an insert or an update. The update is begun by calling JetPrepareUpdate and then by calling JetSetColumn(JET_SESID,JET_TABLEID,JET_COLUMNID,byte[],int,SetColumnGrbit,JET_SETINFO) one or more times to set the record state. Finally, JetUpdate(JET_SESID,JET_TABLEID,byte[],int,out int) is called to complete the update operation. Indexes are updated only by JetUpdate or and not during JetSetColumn.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Constructs a search key that may then be used by JetSeek and JetSetIndexRange.

Write a serialized form of an object to a column.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Modifies a single column value in a modified record to be inserted or to update the current record.

Sets columns from ColumnValue objects.

Initializes static members of the Api class.

Throw an exception if the parameter is an ESE error, returns a JET_wrn otherwise.

Verifies that the given encoding is valid for setting/retrieving data. Only the ASCII and Unicode encodings are allowed. An ArgumentOutOfRangeException is thrown if the encoding isn't valid.

Called to throw an exception with a failing error code.