Api members

Include protected members
Include inherited members

Managed versions of the ESENT API. This class contains static methods that correspond to the unmanaged ESENT API. These methods throw exceptions when errors are returned. Helper methods for the ESENT API. These wrap JetMakeKey. Internal-only methods of the API. Helper methods for the ESENT API. These do data conversion for JetMakeKey. Helper methods for the ESENT API. These methods deal with database metadata. Helper methods for the ESENT API. These aren't interop versions of the API, but encapsulate very common uses of the functions. API members that are marked as obsolete. Helper methods for the ESENT API. These aren't interop versions of the API, but encapsulate very common uses of the functions. Helper methods for the ESENT API. These do data conversion for setting columns.

The Api type exposes the following members.

Methods

  Name Description
Public methodStatic member DeserializeObjectFromColumn(JET_SESID, JET_TABLEID, JET_COLUMNID) Deserialize an object from a column.
Public methodStatic member DeserializeObjectFromColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Deserialize an object from a column.
Public methodStatic member EscrowUpdate Perform atomic addition on one column. The column must be of type Long. This function allows multiple sessions to update the same record concurrently without conflicts.
Public methodStatic member GetBookmark 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.
Public methodStatic member GetColumnDictionary Creates a dictionary which maps column names to their column IDs.
Public methodStatic member GetTableColumnid Get the columnid of the specified column.
Public methodStatic member GetTableColumns(JET_SESID, JET_TABLEID) Iterates over all the columns in the table, returning information about each one.
Public methodStatic member GetTableColumns(JET_SESID, JET_DBID, String) Iterates over all the columns in the table, returning information about each one.
Public methodStatic member GetTableIndexes(JET_SESID, JET_TABLEID) Iterates over all the indexes in the table, returning information about each one.
Public methodStatic member GetTableIndexes(JET_SESID, JET_DBID, String) Iterates over all the indexs in the table, returning information about each one.
Public methodStatic member GetTableNames Returns the names of the tables in the database.
Public methodStatic member IntersectIndexes Intersect a group of index ranges and return the bookmarks of the records which are found in all the index ranges. Also see JetIntersectIndexes(JET_SESID, [], Int32, JET_RECORDLIST, IntersectIndexesGrbit).
Public methodStatic member JetAddColumn Add a new column to an existing table.
Public methodStatic member JetAttachDatabase 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(JET_SESID, String, String, JET_DBID, OpenDatabaseGrbit).
Public methodStatic member JetAttachDatabase2 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(JET_SESID, String, String, JET_DBID, OpenDatabaseGrbit).
Public methodStatic member JetBackupInstance 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.
Public methodStatic member JetBeginExternalBackupInstance Initiates an external backup while the engine and database are online and active.
Public methodStatic member JetBeginSession Initialize a new ESENT session.
Public methodStatic member JetBeginTransaction Causes a session to enter a transaction or create a new save point in an existing transaction.
Public methodStatic member JetBeginTransaction2 Causes a session to enter a transaction or create a new save point in an existing transaction.
Public methodStatic member JetCloseDatabase Closes a database file that was previously opened with JetOpenDatabase(JET_SESID, String, String, JET_DBID, OpenDatabaseGrbit) or created with JetCreateDatabase(JET_SESID, String, String, JET_DBID, CreateDatabaseGrbit).
Public methodStatic member JetCloseFileInstance Closes a file that was opened with JetOpenFileInstance after the data from that file has been extracted using JetReadFileInstance.
Public methodStatic member JetCloseTable Close an open table.
Public methodStatic member JetCommitTransaction 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.
Public methodStatic member JetCompact 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.
Public methodStatic member JetComputeStats 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.
Public methodStatic member JetCreateDatabase Creates and attaches a database file.
Public methodStatic member JetCreateDatabase2 Creates and attaches a database file with a maximum database size specified.
Public methodStatic member JetCreateIndex Creates an index over data in an ESE database. An index can be used to locate specific data quickly.
Public methodStatic member JetCreateIndex2 Creates indexes over data in an ESE database.
Public methodStatic member JetCreateInstance Allocates a new instance of the database engine.
Public methodStatic member JetCreateInstance2 Allocate a new instance of the database engine for use in a single process, with a display name specified.
Public methodStatic member JetCreateTable Create an empty table. The newly created table is opened exclusively.
Public methodStatic member JetCreateTableColumnIndex3 Creates a table, adds columns, and indices on that table.
Public methodStatic member JetDefragment Starts and stops database defragmentation tasks that improves data organization within a database.
Public methodStatic member JetDefragment2 Starts and stops database defragmentation tasks that improves data organization within a database.
Public methodStatic member JetDelete Deletes the current record in a database table.
Public methodStatic member JetDeleteColumn Deletes a column from a database table.
Public methodStatic member JetDeleteColumn2 Deletes a column from a database table.
Public methodStatic member JetDeleteIndex Deletes an index from a database table.
Public methodStatic member JetDeleteTable Deletes a table from a database.
Public methodStatic member JetDetachDatabase Releases a database file that was previously attached to a database session.
Public methodStatic member JetDetachDatabase2 Releases a database file that was previously attached to a database session.
Public methodStatic member JetDupCursor 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.
Public methodStatic member JetDupSession Initialize a new ESE session in the same instance as the given sesid.
Public methodStatic member JetEndExternalBackupInstance 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.
Public methodStatic member JetEndExternalBackupInstance2 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.
Public methodStatic member JetEndSession Ends a session.
Public methodStatic member JetEnumerateColumns Efficiently retrieves a set of columns and their values from the current record of a cursor or the copy buffer of that cursor. The columns and values retrieved can be restricted by a list of column IDs, itagSequence numbers, and other characteristics. This column retrieval API is unique in that it returns information in dynamically allocated memory that is obtained using a user-provided realloc compatible callback. This new flexibility permits the efficient retrieval of column data with specific characteristics (such as size and multiplicity) that are unknown to the caller. This eliminates the need for the use of the discovery modes of JetRetrieveColumn to determine those characteristics in order to setup a final call to JetRetrieveColumn that will successfully retrieve the desired data.
Public methodStatic member JetEscrowUpdate Performs an atomic addition operation on one column. This function allows multiple sessions to update the same record concurrently without conflicts. Also see EscrowUpdate(JET_SESID, JET_TABLEID, JET_COLUMNID, Int32).
Public methodStatic member JetFreeBuffer Frees memory that was allocated by a database engine call.
Public methodStatic member JetGetAttachInfoInstance Used during a backup initiated by JetBeginExternalBackupInstance(JET_INSTANCE, BeginExternalBackupGrbit) to query an instance for the names of database files that should become part of the backup file set. Only databases that are currently attached to the instance using JetAttachDatabase(JET_SESID, String, AttachDatabaseGrbit) will be considered. These files may subsequently be opened using JetOpenFileInstance(JET_INSTANCE, String, JET_HANDLE, Int64, Int64) and read using JetReadFileInstance(JET_INSTANCE, JET_HANDLE, [], Int32, Int32).
Public methodStatic member JetGetBookmark 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(JET_SESID, JET_TABLEID, [], Int32). The bookmark will be no longer than BookmarkMost bytes. Also see GetBookmark(JET_SESID, JET_TABLEID).
Public methodStatic member JetGetColumnInfo(JET_SESID, JET_DBID, String, String, JET_COLUMNBASE) Retrieves information about a column in a table.
Public methodStatic member JetGetColumnInfo(JET_SESID, JET_DBID, String, String, JET_COLUMNDEF) Retrieves information about a table column.
Public methodStatic member JetGetColumnInfo(JET_SESID, JET_DBID, String, String, JET_COLUMNLIST) Retrieves information about all columns in a table.
Public methodStatic member JetGetCurrentIndex 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(JET_SESID, JET_TABLEID, String). It can also be used to discover the properties of that index using JetGetTableIndexInfo.
Public methodStatic member JetGetCursorInfo Determine whether an update of the current record of a cursor will result in a write conflict, based on the current update status of the record. It is possible that a write conflict will ultimately be returned even if JetGetCursorInfo returns successfully. because another session may update the record before the current session is able to update the same record.
Public methodStatic member JetGetDatabaseFileInfo(String, JET_DBINFOMISC, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetDatabaseFileInfo(String, Int32, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetDatabaseFileInfo(String, Int64, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetDatabaseInfo(JET_SESID, JET_DBID, JET_DBINFOMISC, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetDatabaseInfo(JET_SESID, JET_DBID, Int32, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetDatabaseInfo(JET_SESID, JET_DBID, String, JET_DbInfo) Retrieves certain information about the given database.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, JET_INDEXLIST) Obsolete. Retrieves information about indexes on a table.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, JET_INDEXID, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, JET_INDEXLIST, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, Int32, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, String, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetIndexInfo(JET_SESID, JET_DBID, String, String, UInt16, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetInstanceInfo Retrieves information about the instances that are running.
Public methodStatic member JetGetLock 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.
Public methodStatic member JetGetLogInfoInstance Used during a backup initiated by JetBeginExternalBackupInstance(JET_INSTANCE, BeginExternalBackupGrbit) to query an instance for the names of database patch files and logfiles that should become part of the backup file set. These files may subsequently be opened using JetOpenFileInstance(JET_INSTANCE, String, JET_HANDLE, Int64, Int64) and read using JetReadFileInstance(JET_INSTANCE, JET_HANDLE, [], Int32, Int32).
Public methodStatic member JetGetLS 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(JET_SESID, JET_TABLEID, JET_LS, LsGrbit). JetGetLS can also be used to simultaneously fetch the current context handle for a cursor or table and reset that context handle.
Public methodStatic member JetGetObjectInfo(JET_SESID, JET_DBID, JET_OBJECTLIST) Retrieves information about database objects.
Public methodStatic member JetGetObjectInfo(JET_SESID, JET_DBID, JET_objtyp, String, JET_OBJECTINFO) Retrieves information about database objects.
Public methodStatic member JetGetRecordPosition Returns the fractional position of the current record in the current index in the form of a JET_RECPOS structure. Also see JetGotoPosition(JET_SESID, JET_TABLEID, JET_RECPOS).
Public methodStatic member JetGetSecondaryIndexBookmark 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.
Public methodStatic member JetGetSystemParameter(JET_INSTANCE, JET_SESID, JET_param, Int32, String, Int32) Gets database configuration options.
Public methodStatic member JetGetSystemParameter(JET_INSTANCE, JET_SESID, JET_param, IntPtr, String, Int32) Gets database configuration options.
Public methodStatic member JetGetTableColumnInfo(JET_SESID, JET_TABLEID, JET_COLUMNID, JET_COLUMNDEF) Retrieves information about a table column.
Public methodStatic member JetGetTableColumnInfo(JET_SESID, JET_TABLEID, String, JET_COLUMNDEF) Retrieves information about a table column.
Public methodStatic member JetGetTableColumnInfo(JET_SESID, JET_TABLEID, String, JET_COLUMNLIST) Retrieves information about all columns in the table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, JET_INDEXLIST) Obsolete. Retrieves information about indexes on a table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, JET_INDEXID, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, JET_INDEXLIST, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, Int32, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, String, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetTableIndexInfo(JET_SESID, JET_TABLEID, String, UInt16, JET_IdxInfo) Retrieves information about indexes on a table.
Public methodStatic member JetGetTableInfo(JET_SESID, JET_TABLEID, JET_DBID, JET_TblInfo) Retrieves various pieces of information about a table in a database.
Public methodStatic member JetGetTableInfo(JET_SESID, JET_TABLEID, JET_OBJECTINFO, JET_TblInfo) Retrieves various pieces of information about a table in a database.
Public methodStatic member JetGetTableInfo(JET_SESID, JET_TABLEID, Int32, JET_TblInfo) Retrieves various pieces of information about a table in a database.
Public methodStatic member JetGetTableInfo(JET_SESID, JET_TABLEID, [], JET_TblInfo) Retrieves various pieces of information about a table in a database.
Public methodStatic member JetGetTableInfo(JET_SESID, JET_TABLEID, String, JET_TblInfo) Retrieves various pieces of information about a table in a database.
Public methodStatic member JetGetTruncateLogInfoInstance Used during a backup initiated by JetBeginExternalBackupInstance(JET_INSTANCE, BeginExternalBackupGrbit) to query an instance for the names of the transaction log files that can be safely deleted after the backup has successfully completed.
Public methodStatic member JetGetVersion Retrieves the version of the database engine.
Public methodStatic member JetGotoBookmark 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(JET_SESID, JET_TABLEID, [], Int32, Int32).
Public methodStatic member JetGotoPosition Moves a cursor to a new location that is a fraction of the way through the current index. Also see JetGetRecordPosition(JET_SESID, JET_TABLEID, JET_RECPOS).
Public methodStatic member JetGotoSecondaryIndexBookmark 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(JET_SESID, JET_TABLEID, [], Int32, [], Int32, GotoSecondaryIndexBookmarkGrbit).
Public methodStatic member JetGrowDatabase Extends the size of a database that is currently open.
Public methodStatic member JetIdle Performs idle cleanup tasks or checks the version store status in ESE.
Public methodStatic member JetIndexRecordCount 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.
Public methodStatic member JetInit Initialize the ESENT database engine.
Public methodStatic member JetInit2 Initialize the ESENT database engine.
Public methodStatic member JetIntersectIndexes 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(JET_SESID, []).
Public methodStatic member JetMakeKey Constructs search keys that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member JetMove(JET_SESID, JET_TABLEID, JET_Move, MoveGrbit) 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(JET_SESID, JET_TABLEID), TryMoveLast(JET_SESID, JET_TABLEID), TryMoveNext(JET_SESID, JET_TABLEID), TryMovePrevious(JET_SESID, JET_TABLEID).
Public methodStatic member JetMove(JET_SESID, JET_TABLEID, Int32, MoveGrbit) 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(JET_SESID, JET_TABLEID), TryMoveLast(JET_SESID, JET_TABLEID), TryMoveNext(JET_SESID, JET_TABLEID), TryMovePrevious(JET_SESID, JET_TABLEID).
Public methodStatic member JetOpenDatabase Opens a database previously attached with JetAttachDatabase(JET_SESID, String, AttachDatabaseGrbit), for use with a database session. This function can be called multiple times for the same database.
Public methodStatic member JetOpenFileInstance 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.
Public methodStatic member JetOpenTable Opens a cursor on a previously created table.
Public methodStatic member JetOpenTempTable 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 JetOpenTempTable3(JET_SESID, [], Int32, JET_UNICODEINDEX, TempTableGrbit, JET_TABLEID, []). JetOpenTemporaryTable(JET_SESID, JET_OPENTEMPORARYTABLE).
Public methodStatic member JetOpenTempTable2 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 JetOpenTempTable(JET_SESID, [], Int32, TempTableGrbit, JET_TABLEID, []), JetOpenTempTable3(JET_SESID, [], Int32, JET_UNICODEINDEX, TempTableGrbit, JET_TABLEID, []). JetOpenTemporaryTable(JET_SESID, JET_OPENTEMPORARYTABLE).
Public methodStatic member JetOpenTempTable3 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 JetOpenTempTable(JET_SESID, [], Int32, TempTableGrbit, JET_TABLEID, []), JetOpenTemporaryTable(JET_SESID, JET_OPENTEMPORARYTABLE).
Public methodStatic member JetOSSnapshotFreeze Starts a snapshot. While the snapshot is in progress, no write-to-disk activity by the engine can take place.
Public methodStatic member JetOSSnapshotPrepare 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).
Public methodStatic member JetOSSnapshotThaw Notifies the engine that it can resume normal IO operations after a freeze period and a successful snapshot.
Public methodStatic member JetPrepareUpdate Prepare a cursor for update.
Public methodStatic member JetReadFileInstance Retrieves the contents of a file opened with JetOpenFileInstance(JET_INSTANCE, String, JET_HANDLE, Int64, Int64).
Public methodStatic member JetRegisterCallback 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(JET_INSTANCE).
Public methodStatic member JetRenameColumn Changes the name of an existing column.
Public methodStatic member JetRenameTable Changes the name of an existing table.
Public methodStatic member JetResetSessionContext Disassociates a session from the current thread. This should be used in conjunction with JetSetSessionContext(JET_SESID, IntPtr).
Public methodStatic member JetResetTableSequential 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(JET_SESID, JET_TABLEID, SetTableSequentialGrbit).
Public methodStatic member JetRestoreInstance 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 JetBackupInstance(JET_INSTANCE, String, BackupGrbit, JET_PFNSTATUS) function. This is the simplest and most encapsulated restore function.
Public methodStatic member JetRetrieveColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, [], Int32, Int32, RetrieveColumnGrbit, JET_RETINFO) 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.
Public methodStatic member JetRetrieveColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, [], Int32, Int32, Int32, RetrieveColumnGrbit, JET_RETINFO) 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.
Public methodStatic member JetRetrieveColumns 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.
Public methodStatic member JetRetrieveKey Retrieves the key for the index entry at the current position of a cursor. Also see RetrieveKey(JET_SESID, JET_TABLEID, RetrieveKeyGrbit).
Public methodStatic member JetRollback 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.
Public methodStatic member JetSeek 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, [], Int32, MakeKeyGrbit). Also see TrySeek(JET_SESID, JET_TABLEID, SeekGrbit).
Public methodStatic member JetSetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, [], Int32, SetColumnGrbit, JET_SETINFO) 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 LongText or LongBinary).
Public methodStatic member JetSetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, [], Int32, Int32, SetColumnGrbit, JET_SETINFO) 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 LongText or LongBinary).
Public methodStatic member JetSetColumnDefaultValue Changes the default value of an existing column.
Public methodStatic member JetSetColumns 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.
Public methodStatic member JetSetCurrentIndex Set the current index of a cursor.
Public methodStatic member JetSetCurrentIndex2 Set the current index of a cursor.
Public methodStatic member JetSetCurrentIndex3 Set the current index of a cursor.
Public methodStatic member JetSetCurrentIndex4 Set the current index of a cursor.
Public methodStatic member JetSetDatabaseSize Sets the size of an unopened database file.
Public methodStatic member JetSetIndexRange Temporarily limits the set of index entries that the cursor can walk using JetMove(JET_SESID, JET_TABLEID, Int32, 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, [], Int32, MakeKeyGrbit). Also see TrySetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member JetSetLS 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.
Public methodStatic member JetSetSessionContext 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(JET_SESID) to remove the association.
Public methodStatic member JetSetSystemParameter(JET_INSTANCE, JET_SESID, JET_param, JET_CALLBACK, String) Sets database configuration options.
Public methodStatic member JetSetSystemParameter(JET_INSTANCE, JET_SESID, JET_param, Int32, String) Sets database configuration options.
Public methodStatic member JetSetSystemParameter(JET_INSTANCE, JET_SESID, JET_param, IntPtr, String) Sets database configuration options.
Public methodStatic member JetSetTableSequential 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(JET_SESID, JET_TABLEID, ResetTableSequentialGrbit).
Public methodStatic member JetStopBackupInstance Prevents streaming backup-related activity from continuing on a specific running instance, thus ending the streaming backup in a predictable way.
Public methodStatic member JetStopServiceInstance Prepares an instance for termination.
Public methodStatic member JetTerm Terminate an instance that was created with JetInit(JET_INSTANCE) or JetCreateInstance(JET_INSTANCE, String).
Public methodStatic member JetTerm2 Terminate an instance that was created with JetInit(JET_INSTANCE) or JetCreateInstance(JET_INSTANCE, String).
Public methodStatic member JetTruncateLogInstance 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.
Public methodStatic member JetUnregisterCallback Configures the database engine to stop issuing notifications to the application as previously requested through JetRegisterCallback(JET_SESID, JET_TABLEID, JET_cbtyp, JET_CALLBACK, IntPtr, JET_HANDLE).
Public methodStatic member JetUpdate(JET_SESID, JET_TABLEID) 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(JET_SESID, JET_TABLEID).
Public methodStatic member JetUpdate(JET_SESID, JET_TABLEID, [], Int32, Int32) 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(JET_SESID, JET_TABLEID).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Boolean, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Byte, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, [], MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, DateTime, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Double, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Guid, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Int16, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Int32, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Int64, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, Single, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, UInt16, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, UInt32, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, UInt64, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MakeKey(JET_SESID, JET_TABLEID, String, Encoding, MakeKeyGrbit) Constructs a search key that may then be used by JetSeek(JET_SESID, JET_TABLEID, SeekGrbit) and JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit).
Public methodStatic member MoveAfterLast Position the cursor after the last record in the table. A subsequent move previous will position the cursor on the last record.
Public methodStatic member MoveBeforeFirst Position the cursor before the first record in the table. A subsequent move next will position the cursor on the first record.
Public methodStatic member ResetIndexRange Removes an index range created with JetSetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit) or TrySetIndexRange(JET_SESID, JET_TABLEID, SetIndexRangeGrbit). If no index range is present this method does nothing.
Public methodStatic member RetrieveColumn(JET_SESID, JET_TABLEID, JET_COLUMNID) 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.
Public methodStatic member RetrieveColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit, JET_RETINFO) 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.
Public methodStatic member RetrieveColumnAsBoolean(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a boolean column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsBoolean(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a boolean column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsByte(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a byte column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsByte(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a byte column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsDateTime(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a datetime column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsDateTime(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a datetime column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsDouble(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a double column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsDouble(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a double column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsFloat(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a float column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsFloat(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a float column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsGuid(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a guid column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsGuid(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a guid column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsInt16(JET_SESID, JET_TABLEID, JET_COLUMNID) 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.
Public methodStatic member RetrieveColumnAsInt16(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves an int16 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsInt32(JET_SESID, JET_TABLEID, JET_COLUMNID) 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.
Public methodStatic member RetrieveColumnAsInt32(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves an int32 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsInt64(JET_SESID, JET_TABLEID, JET_COLUMNID) 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.
Public methodStatic member RetrieveColumnAsInt64(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) 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.
Public methodStatic member RetrieveColumnAsString(JET_SESID, JET_TABLEID, JET_COLUMNID) 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. The Unicode encoding is used.
Public methodStatic member RetrieveColumnAsString(JET_SESID, JET_TABLEID, JET_COLUMNID, Encoding) Retrieves a string column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsString(JET_SESID, JET_TABLEID, JET_COLUMNID, Encoding, RetrieveColumnGrbit) Retrieves a string column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt16(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a uint16 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt16(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a uint16 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt32(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a uint32 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt32(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a uint32 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt64(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves a uint64 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumnAsUInt64(JET_SESID, JET_TABLEID, JET_COLUMNID, RetrieveColumnGrbit) Retrieves a uint64 column value from the current record. The record is that record associated with the index entry at the current position of the cursor.
Public methodStatic member RetrieveColumns Retrieves columns into ColumnValue objects.
Public methodStatic member RetrieveColumnSize(JET_SESID, JET_TABLEID, JET_COLUMNID) Retrieves the size of 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.
Public methodStatic member RetrieveColumnSize(JET_SESID, JET_TABLEID, JET_COLUMNID, Int32, RetrieveColumnGrbit) Retrieves the size of 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.
Public methodStatic member RetrieveKey Retrieves the key for the index entry at the current position of a cursor.
Public methodStatic member SerializeObjectToColumn Write a serialized form of an object to a column.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Boolean) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Byte) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, []) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, DateTime) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Double) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Guid) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Int16) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Int32) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Int64) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, Single) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, UInt16) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, UInt32) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, UInt64) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, [], SetColumnGrbit) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, String, Encoding) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumn(JET_SESID, JET_TABLEID, JET_COLUMNID, String, Encoding, SetColumnGrbit) Modifies a single column value in a modified record to be inserted or to update the current record.
Public methodStatic member SetColumns Sets columns from ColumnValue objects.
Public methodStatic member TryGetLock 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.
Public methodStatic member TryMove Try to navigate through an index. If the navigation succeeds this method returns true. If there is no record to navigate to this method returns false; an exception will be thrown for other errors.
Public methodStatic member TryMoveFirst Try to move to the first record in the table. If the table is empty this returns false, if a different error is encountered an exception is thrown.
Public methodStatic member TryMoveLast Try to move to the last record in the table. If the table is empty this returns false, if a different error is encountered an exception is thrown.
Public methodStatic member TryMoveNext Try to move to the next record in the table. If there is not a next record this returns false, if a different error is encountered an exception is thrown.
Public methodStatic member TryMovePrevious Try to move to the previous record in the table. If there is not a previous record this returns false, if a different error is encountered an exception is thrown.
Public methodStatic member TryOpenTable Try to open a table.
Public methodStatic member TrySeek 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.
Public methodStatic member TrySetIndexRange Temporarily limits the set of index entries that the cursor can walk using JetMove 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. Returns true if the index range is non-empty, false otherwise.

Top

See also

Reference

Api class

Microsoft.Isam.Esent.Interop namespace