| Name | Description | |
|---|---|---|
 | ActiveIndex | Name of active index that determines row order when walking the table with First(), Last(), Prev(), and Next() and when applying SetScope(...), etc. A null setting for ActiveIndex selects the table's natural storage order (generally the order rows were originally inserted). (Inherited from VistaDB.DDA.IVistaDBTable) |
| ArePagesEncrypted | Whether this database is encrypted at the database page level. () |
| CanDatabaseVersionEncryptPages | Whether the format version of this database supports page encryption (true) or only column encryption (false). If true then the column attribute "Encrypted" is meaningless. () |
| CaseSensitive | Database sensitivity in character data |
| Culture | Database culture used to collate character data or apply date and time masks in filters or queries |
| CurrentKey | Gets a copy of the current key row under the ActiveIndex, or sets the current key row from the row instance provided (such as from a previous get under the same ActiveIndex). Copies returned by get can be modifed and used in SetScope. (Inherited from VistaDB.DDA.IVistaDBTable) |
| CurrentRow | Gets a copy of the entire current row of the table, or sets the modified column values into the pending-row placeholder to be submitted by a Post for update or insert. DO NOT MIX setting CurrentRow and using Put... methods on the table for the same operation. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Description | Database description |
| EndOfTable | Tests if a record movement function has placed the row pointer beyond the last row in the table under the ActiveIndex (also true if the table is empty). (Inherited from VistaDB.DDA.IVistaDBTable) |
| EnforceConstraints | Gets or sets a value indicating whether constraint rules are followed when attempting any insert, update or delete operation (Inherited from VistaDB.DDA.IVistaDBTable) |
| EnforceIdentities | Gets or sets a value indicating whether identities are active when attempting any insert operation (Inherited from VistaDB.DDA.IVistaDBTable) |
| IdentityInsert | Get or set the manual setting for IDENTITY_INSERT ON (true) or OFF (false) for this table. This is independent from the one-table-at-a-time setting for a SQL connection but provides the same basic functionality to allow explicit value insertion for identity columns. (Inherited from VistaDB.DDA.IVistaDBTable) |
| IsClosed | Get the value indicating whether the table is closed (Inherited from VistaDB.DDA.IVistaDBTable) |
| IsDatabaseCurrentFormatVersion | Whether the format version of this database is the current version (the latest version known to this version of the VistaDB provider engine). |
| IsolatedStorage | Database file resides in isolated storage |
| IsolationLevel | Isolation level for current transaction |
| LastSessionIdentity | Read the memory-cached value of last insert operation made to the identity columns by this table instance (Inherited from VistaDB.DDA.IVistaDBTable) |
| LastTableIdentity | Read the last value of identity columns that will be used by any client in nearest insert operation. This value is saved in the file storage. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Mode | Read current database opening mode |
| Name | Table name (Inherited from VistaDB.DDA.IVistaDBTable) |
| NestedTransactionLevel | Current level for nested transactions |
| PageEncryptionAlgorithm | The algorithm used to encrypt database pages ("None" if not enabled, null if N/A for this database format). () |
| PageSize | The Page size in kilobytes. A setting of 1 = 1,024 bytes. |
| RegularIndexes | Get collection of regular indexes created and/or opened in this table instance (Inherited from VistaDB.DDA.IVistaDBTable) |
| Relationships | Relationships collection from the database |
| RowCount | Number of physical rows in the table (Inherited from VistaDB.DDA.IVistaDBTable) |
| ScopeKeyCount | Scans active index and calculates the keys in it, taking current scope operators into account. (WARNING: CAUSES SIDE-EFFECTS: The current row position of the parent table becomes undefined/EOF) (Inherited from VistaDB.DDA.IVistaDBTable) |
| StartOfTable | Tests if a record movement function has placed the row pointer before the first row in the table under the ActiveIndex (also true if the table is empty). (Inherited from VistaDB.DDA.IVistaDBTable) |
| TemporaryIndexes | Get collection of temporary indexes created and assigned to this table instance (Inherited from VistaDB.DDA.IVistaDBTable) |
| VersionGuid | Read only unique identifier assigned to this database schema version. Used for sync and schema updates systems. You cannot infer anything to the meaning of the guid other than to compare if they are equal. If they are equal then you have two databases with the exact same schema version. |
IVistaDBDatabase Interface Members
In This Topic
The following tables list the members exposed by IVistaDBDatabase.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | ActivateSyncService | Restructure table in order to allow sync service to work |
| AddAssembly | Add assembly from external file and store it in database for use by CLR Procs, triggers, etc. Does not load any third party dependencies. If you need an external dependency to be included you should ILMERGE the assemblies together. |
| AddToXmlTransferList | Add table name to the table transfer list used by xml ExportXml/ImportXml functions. |
| AlterTable | Alter table in according to new table schema |
| BeginTransaction | Overloaded. Begin transaction in ReadCommitted isolation level |
| ClearXmlTransferList | Clear table transfer list used by xml export/import routines. |
| Close | Close the table and clear respective resources (Inherited from VistaDB.DDA.IVistaDBTable) |
| CommitTransaction | Commit transaction |
| ContainsTable | Does this database contain a table with this name? |
| CreateConstraint | Create constraint to check after insert, update or before delete operations (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateDefaultValue | Create a default value for a column using an expression. (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateForeignKey | Create foreign key constraint that instantiates respective relationship in the database (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateFTSIndex | Create special index to use by full text search. Identity columns may not be used for FullTextSearch indexes. Only a single FullTextSearch index may exist per table. (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateIdentity | Create and initialize identity counter. Applied to integer type columns only. (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateIndex | Create an index on current table. This may be a unique constrained index, or a primary key index. (Inherited from VistaDB.DDA.IVistaDBTable) |
| CreateTable | Create new table given the table schema. You should call NewTable() first to get the schema to pass to this function. |
| CreateTemporaryIndex | Create temporary index from given keyExpression. The index is not added to database but kept separately in the user temporary folder. The file is deleted by engine when the table is closed. (Inherited from VistaDB.DDA.IVistaDBTable) |
| DeactivateSyncService | Restructure table in order to exclude meta information allowing sync service to work |
| Delete | Immediately deletes current row and reset row lock if it was set before delete operation. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from System.IDisposable) |
| DropAssembly | Drop the assembly from database |
| DropConstraint | Drop existing constraint (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropDefaultValue | Drop an existing default value (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropForeignKey | Drop foreign key constraint. Respective foreign key index will be deleted from the table as well. (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropFTSIndex | Drop full text search index. No params are required as there may be only one Full Text Search (FTS) Index per table. (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropIdentity | Drop existing identity column (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropIndex | Drop existing index (Inherited from VistaDB.DDA.IVistaDBTable) |
| DropTable | Drop existing table. The engine will verify it is possible to delete the table and maintain relationships integrity in the database before allowing the DropTable to succeed. |
| Evaluate | Evaluate expression. (Inherited from VistaDB.DDA.IVistaDBTable) |
| ExportData | To export table data using constraint set on destination table. (Inherited from VistaDB.DDA.IVistaDBTable) |
| ExportXml | Export database schema and table data to xml-formated file according to the transfer list of tables. If relationships set in database, the information will be exported only concerning those ones, which link tables included into the transfer list. |
| Find | Find an expression in an index. This is for searching for exact and partial matching records. (Inherited from VistaDB.DDA.IVistaDBTable) |
| First | Set current row pointer to the first row position under the current ActiveIndex (and any applied scope). If there are no rows, the EndOfTable flag is set to true. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Get | Get column value by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| GetAssemblies | Get a collection of the assemblies currently registered in the database (CLR Procs, CLR Triggers, etc). |
| GetClrProcedures | Get collection of Clr Procs in database |
| GetClrTriggers | Overloaded. Collection of CLR Triggers registered in database. These triggers are contained within an assembly and referenced through trigger naming. |
| GetFilter | Gets filter expression for current table state. (Inherited from VistaDB.DDA.IVistaDBTable) |
| GetLastIdentity | Get last value assigned to the identity column in table insert operation at this database instance. The table inserted the row may be already closed at current moment. |
| GetLastTimestamp | Get last value assigned to the timestamp column in the table insert operation for this database instance. The table inserted the row may be already closed at current moment. |
| GetScope | Gets copies of the lower and upper key rows of the currently set scope constraining the range of rows under the current ActiveIndex. (Columns will all be set to extreme values if no scope has been set.) (Inherited from VistaDB.DDA.IVistaDBTable) |
| GetTableNames | Collection of table information |
| GetToFile | Read Text, NText, Image data from database and put them to external file. (Inherited from VistaDB.DDA.IVistaDBTable) |
| ImportXml | Overloaded. Update database schema and import table data in according to the transfer list of tables. |
| Insert | Start an insert operation and create a placeholder row in memory. Values can then be set either by calling various Put... methods on the table OR by getting the CurrentRow and then assigning back to CurrentRow after setting column values in the instance. Submit by calling IVistaDBTable.Post or IVistaDBTable.Post. (Inherited from VistaDB.DDA.IVistaDBTable) |
| InvokeClrProcedure | Invoke Clr Procedure. Assembly must already be loaded into database and procedure name associated. |
| InvokeClrProcedureFillRow | Invoke the FillRow method for Clr Procedure |
| Last | Set current row pointer to the last row position under the current ActiveIndex (and any applied scope). If there are no rows, the EndOfTable flag is set to true. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Lock | Lock row. If zero is passed, the entire table will be locked (Inherited from VistaDB.DDA.IVistaDBTable) |
| MoveBy | Advances current row pointer position by a specified number of rows forward (positive) or back (negative) under the current ActiveIndex. (Inherited from VistaDB.DDA.IVistaDBTable) |
| NewTable | The first method to call in order to create new table in database. This method instantiates an IVistaDBTableSchema object and returns it. |
| Next | Advances current row pointer to the next row under the current ActiveIndex. If there were no more rows to move forward to, the EndOfTable flag will be set to true. (Inherited from VistaDB.DDA.IVistaDBTable) |
| OpenTable | Open table |
| Post | Finalize a pending insert or update operation and optionally release the row lock or leave it locked for further action. (Inherited from VistaDB.DDA.IVistaDBTable) |
| PrepareClrContext | Overloaded. Prepare current context to use by Clr Procedure or Trigger |
| Prev | Move current row pointer to the previous row under the current ActiveIndex. If there were no previous rows to move back to, the StartOfTable flag will be set to true. (Inherited from VistaDB.DDA.IVistaDBTable) |
| Put | Assign column value with system type value by column order in the row. (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutBinary | Assign array of bytes value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutBoolean | Assign boolean value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutByte | Assign byte value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutDateTime | Assign DateTime value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutDateTimeOffset | Assign DateTimeOffset value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutDecimal | Assign Decimal value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutDouble | Assign Double value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutFromFile | Put Text, NText, Image data from external file to a column. (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutGuid | Assign Guid value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutInt16 | Assign int16 value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutInt32 | Assign int32 value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutInt64 | Assign int64 value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutNull | Set null value by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutSingle | Assign Float value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutString | Assign string value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| PutTime | Assign TimeSpan value to column by column's name (Inherited from VistaDB.DDA.IVistaDBTable) |
| RegisterClrProcedure | Looks for CLR Proc in assembly. If CLR Proc found, registers the link to this method by custom name |
| RegisterClrTrigger | Looks for CLR Trigger in assembly. If CLR Trigger found, registers user provided name. |
| RenameIndex | Rename existing index without rebuilding. (Inherited from VistaDB.DDA.IVistaDBTable) |
| ResetEventDelegate | Reset event delegate type called by DDA (Inherited from VistaDB.DDA.IVistaDBTable) |
| ResetFilter | Reset all filters (Inherited from VistaDB.DDA.IVistaDBTable) |
| ResetScope | Reset scope in active index to the entire table. (Inherited from VistaDB.DDA.IVistaDBTable) |
| RollbackTransaction | Rollback current transaction |
| SetDDAEventDelegate | Set delegate method called by core engine by event (Inherited from VistaDB.DDA.IVistaDBTable) |
| SetFilter | Set filter expression and try to optimize it if the optimize parameter is true (Inherited from VistaDB.DDA.IVistaDBTable) |
| SetOperationCallbackDelegate | Defines a delegate that time consuming operations may call back in order to inform the user as to the progress of the operation and additional information. (Inherited from VistaDB.DDA.IVistaDBTable) |
| SetScope | Set the scope for the table to constrain the range of rows under the ActiveIndex. After setting an ActiveIndex on the table (or null to use natural storage order) you can get copies from the CurrentKey property for row instances with the correct schema to use as the arguments. (Inherited from VistaDB.DDA.IVistaDBTable) |
| TableSchema | Get table schema existing in the database. You may read table schema without opening the table |
| TestDatabaseObjectName | Test if name of table, column, index etc. is correct |
| Unlock | Unlock row. If zero is passed, the entire table will be unlocked and all existing row locks will be released (Inherited from VistaDB.DDA.IVistaDBTable) |
| UnprepareClrContext | Release current context used by CLR Proc |
| UnregisterClrProcedure | Unregister the link to CLR Proc |
| UnregisterClrTrigger | Unregister the link to CLR Trigger |
| UpdateAssembly | Update existing assembly registered in database with new assembly. Will remove any clr procs or functions that are not present in new assembly. Third party assemblies are not loaded into the database. |
See Also