| Name | Description | |
|---|---|---|
 | DataHelper Constructor | Overloaded. |
The following tables list the members exposed by DataHelper.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | AfterDelete | Set to intercept an object after a record is deleted |
| AfterInsert | Set to intercept an object after a record is inserted |
| AfterRead | Set to intercept an object after it is read |
| AfterUpdate | Set to intercept an object after a record is updated |
| BeforeDelete | Set to intercept an object before a record is deleted |
| BeforeInsert | Set to intercept an object before a record is inserted |
| BeforeUpdate | Set to intercept an object before a record is updated |
| Connection | Get a reference to the current connection |
| ConnectionString | Get or set the Connection String of the Database Provider |
| CurrentTransactionNesting | Used for viewing the internal level of nested transactions. Each Begin Transaction adds 1. Each Commit Transaction subtracts 1. |
| FillInMaintenanceFields | If true, properties such as CreateDate, UpdateDate, CreateUser will be automatically filled in before saving The default is true |
| IsConnectionOpen | True if the connection is open |
| IsFileBasedDatabase | Gets a value indicating whether the provider is file based database. |
| IsInTransaction | Returns true if we are in a transaction |
 | IsSessionCreated | Returns true if the session has been created for the current thread |
| LicenseKey | The license key associated with a license. See the License Key on your receipt. |
| MaintenanceFields | A list of the names maintenance fields that will be filled in automatically such as CreateDate, UpdateDate, CreateUser |
| Mapper | Map objects, table names, and sql to database tables |
| NestedTransactions | When true, Inner Begin Transactions and Commit Transactions are allowed. Inner Commits do not actually commit until the outermost commit has occured. Default is false. Nested transactions are useful for rolling back integration tests. |
| ParameterPrefix | Get or Set the Prefix used for Parameters |
| Provider | Get the database provider that was set in the constructor |
| ProviderName | Get the type of the provider |
| SetDefaults | If true, defaults will be set in the object before it is sent to the database. The default is false |
| SupportsIdentity | Returns true if the attached database provider supports identity columns |
| SupportsStoredProcedures | Returns true if the attached database provider supports stored procedures |
| Transaction | Get a reference to the current transaction |
| UserName | The user name associated with a license. See the User Name on your receipt. |
Public Methods
| Name | Description | |
|---|---|---|
 | AddColumn | Adds the column to the passed in table |
| AddMaintenanceFields | Adds the maintenance fields to the passed in table if they do not exist |
| AnyRecordExists | Overloaded. Returns true if any records exist in a table |
| BeginTransaction | Begin a new transaction |
| ChangeDatabase | Change database |
| ClearLog | Overloaded. Clear the file log |
| CloseConnection | Close the database connection |
| CommitTransaction | Commit the current transaction |
| ConnectionValid | Opens and closes the connection to ensure it is valid |
| Count<T> | Return the count of records in the table |
| CountRecordsInTable | Get the number of records in a table |
| CreateClassesForDatabase | Create classes for the current database in the passed in namespace |
| CreateClassFromTable | Create a C# class from a table |
| CreateDatabase | Overloaded. Create new database |
| CreateIndex | Create an index for the passed in table |
| CreateQuery<T> | Create a LINQ query using an enhanced version of the IQToolkit |
| CreateTableFromClass<T> | Create a table in the database based on the passed class |
| CreateTablesFromNamespace | Overloaded. Create a table in the database for each class that is in the passed in namespace |
| CreateVbClassFromTable | Create a VB.NET class from a table |
| DatabaseExists | Overloaded. Check database existance |
| Delete | Overloaded. Delete a record where all parameters are equal |
| DeleteByPrimaryKey<T> | Delete an object by the primary key |
| DeleteWithChildren | Overloaded. Delete an object by the primary key and all its children |
| DisableLogging | Disable all logging |
| Dispose | Close the connection on dispose |
| DropSequence | Drop (remove) a table's sequence from database |
| DropTable | Overloaded. Drop a table associated with a class |
| DropTrigger | Drop (remove) a sequence's trigger from database |
| EnableLogging | Overloaded. Log to the console |
| ExecuteNonQuery | Overloaded. Execute the passed query and return the number of affected records |
| ExecuteNonQuerySproc | Overloaded. Execute the passed stored procedure and return the number of affected records |
| ExecuteScalar | Overloaded. Execute the passed query and return the first column of the first row |
| ExecuteScalarSproc | Overloaded. Execute the passed stored procedure and return the first column of the first row |
| ExtendTrial | Extend the trial of the software |
| FillDataTable | Overloaded. Fill the passed data table with the passed query |
| ForeignKeyExists | Returns true if the Foreign Key Exists |
| GenerateNamespaceSql | Overloaded. Create the SQL needed to create all the tables for the namespace |
| GenerateTablesSql | Generate the SQL for creating the list of tables |
| GenerateUpgradeNamespaceSql | Overloaded. Create the SQL needed to upgrade all the tables for the namespace |
| GenerateUpgradeTableSql | Overloaded. Generate SQL to upgrade a single table |
| GetAllConstraints | Get all Foreign Key constraints for the current database |
| GetDatabases | Get a list of the databases or schemas on the database server. For providers that do not support multiple databases or schemas, the list will be empty. |
| GetDatabaseServerDate | Get the date of the database server. For providers that do not have a database date, DateTime.Now is returned. |
| GetDatabaseTables | Get a list of tables in the current database with the associated indexes and foreign keys, sorted alphabetically |
| GetDatabaseTablesWithoutIndexesOrForeignKeys | Get a list of tables in the current database WITHOUT the associated indexes or foreign keys, sorted alphabetically |
| GetDatabaseTypeForDbType | Get the database field type for the passed standard DbType. Used internally for creating tables. Can be also used externally for code generation. |
| GetDataTable | Overloaded. Get a datatable from the passed query |
| GetDbTypeForClrType | Get the DbType for provided ClrType. Used internally for creating tables. Can be also used externally for code generation. |
| GetIdentity | Get the last identity that was inserted |
| GetIdentitySql | Get the SQL used to get the identity for the last inserted record |
| GetIndexesForTable | Gets the indexes for a table. |
| GetLazyValue<T,TC> | Load a child or a parent by the property name lambda |
| GetMaxPrimaryKey | Overloaded. Get the maximum value for a primary key. |
| GetObjectMap<T> | Get the object map for the passed class. Useful for code generation or getting schema information. |
| IndexExists | Detect if an index exists |
| Insert | Overloaded. Insert a record into the table |
| Load | Overloaded. Select records using the passed SQL and return a list of dictionary records. |
| LoadAll | Overloaded. Load all the records from a table into a class list |
| LoadAllWithChildren | Overloaded. Load all the records from a table and its children and parents into a class list |
| LoadByColumn<T> | Load records based on a column into a class list |
| LoadByColumnWithChildren<T> | Same as LoadByColumn except loads the associated children |
| LoadByPrimaryKey<T> | Load a single record using the primary key |
| LoadFromSproc | Overloaded. Get a list of records using the passed Stored Procedure |
| LoadFromSprocWithChildren | Overloaded. Load a list of objects from a stored procedure with all children |
| LoadLookup | Overloaded. Return a list of items with the primary key and the first string column ordered by the first string column |
| LoadOne | Overloaded. Get a single record for a table and a parameterized where clause and return a dictionary. |
| LoadPage | Overloaded. Get a page of records for a table |
| LoadPageWithChildren | Overloaded. Load a page of records with children that are filtered by a where clause and ordered |
| LoadTop | Overloaded. Get a limited number of records for a table |
| LoadWhere | Overloaded. Load entities matching the passed in where clause |
| LoadWithChildren | Overloaded. Load all the records from a table and its children and parents into a class list |
| OpenConnection | Open the database connection |
| RecordExists | Overloaded. Returns true if the record exists |
| RollbackTransaction | Perform a rollback of the current transaction |
| Save | Overloaded. Inserts, Updates or Deletes a record in the table. If the primary key is zero or null, it is an insert otherwise an update. If IsDeleted is set, the record is deleted. |
| SaveWithChildren | Overloaded. Save an object with its parent and children |
| Search | Overloaded. Search for records based on the passed in search object. If the value is null or the default value, then the item will not be part of the where clause. |
| SearchCount<T> | Count the number of records for a search |
| SessionFactory | Get a thread static safe Data Helper Session. The session is automatically created on the first access. The same session is retrieved per thread after the first call. |
| SetForeignKeys<T,TU> | Set the foreign primaryKey of the child object to the primaryKey of the parent object. This is done automatically for SaveWithChildren |
| Setup | Overloaded. Create the database if it does not exist. Create tables that do not exist. Create columns that do not exist. |
| StoredProcedureExists | Returns true if the passed stored procedure exists in the database |
| SynchronizeNamespaceStructure | Overloaded. Synchronize table structure for each class that is in the passed in namespace |
| SynchronizeTableStructure<T> | Synchronize table structure with the specified by typeparam class |
| SyncTableFromEnum | Create/Update a table and fill with values from an enum. |
| TableExists | Overloaded. Returns true if the passed table exists in the database |
| TruncateTable | Overloaded. Delete all the records from a table |
| Update | Overloaded. Update a record in the database by a composite primaryKey |
See Also