#Driver
##Properties
| Datatype | Property name | Property description | Default Value |
|---|---|---|---|
| Boolean | AlwaysGenerateAs | Determines whether fields will always use the "AS" keyword when generating SQL queries. (deprecated) | inherited from concrete class |
| String | AsForTables | Represents the keyword used to separate identifiers from aliases. | inherited from concrete class |
| String | CacheKeyBase | Gets a System.String that represents a unique key that can be used to query the cache.(deprecated) | inherited from concrete class |
| Int32 | CmdTimeout | inherited from concrete class | |
| IDbConnection | Connection | Gets the current connection to the database or creates a new one if one does not exist or if the existing connection is dropped. | inherited from concrete class |
| IDbConnection | ConnectionOpened | inherited from concrete class | |
| String | ConnectionString | Represents the default connection string for the driver in use. | inherited from concrete class |
| DatabaseSchema | DatabaseSchema | Represents the schema obtained from the database. | inherited from concrete class |
| String[] | DateFormats | Gets a collection of all the date format strings that are available. | inherited from concrete class |
| String | DefaultSchemaName | Represents the name of the default schema of the DBMS for this driver. | inherited from concrete class |
| Encoding | Encoding | inherited from concrete class | |
| String[] | MainFusionDriverAllAliases | inherited from concrete class | |
| Hashtable | NativeToInternalTypesMap | Collection of the key-value pairs to map native DB types to corresponding Izenda types Key - DB native type (type of String) Value - Corresponding Izenda.AdHoc.Database.SqlType | inherited from concrete class |
| List | NativeTypesOverrides | Collection of the key-value pairs that is used to create a temporary table when SP is used as a data source. Key - SqlDbType Value - corresponding native DB type | inherited from concrete class |
| Boolean | OnlyNullIsBlank | inherited from concrete class | |
| Int64 | QuantityOfCallsInvalidate | Gets the number of requests to the web server to invalidate before accepting requests again. | inherited from concrete class |
| TimeSpan | QueryCachingTime | Represents the period of time that queries made to the database will remain in the cache. Cached queries exist within application memory until this time period has elapsed or the queries cache is invalidated. The default is five minutes. | inherited from concrete class |
| TimeSpan | SchemaCachingTime | Represents the period of time that the database schema will remain in the cache before it is invalidated and will be re-loaded from the database. The default is one day. | inherited from concrete class |
| Hashtable | SqlTypeToDbTypeMap | Collection of the key-value pairs to map Izenda internal SqlType enum type to the .Net DbType Key - SqlType Value - DbType corresponding .Net DbType | inherited from concrete class |
| Boolean | SupportsCreateDateExpression | Determines if the version of the database supports the ability to create a date from portions of a date. | inherited from concrete class |
| Boolean | UseTablesFromSchemaOnly | Determines whether data sources only from the default for the current connection/user schema will be used. | inherited from concrete class |
| Version | Version | Gets the version of the database that is being connected to. Once the version has been obtained, its value will be cached to disk. | inherited from concrete class |
##Methods
###AddConstraint(System.String,System.String) Represents a method used to add a primary/foreign key relationship between two tables' columns in the schema using an INNER JOIN. The wildcard "*" is accepted and column names are case sensitive.
Parameters:
- System.String primaryColumn - The fully-qualified column name or wildcard to use as the primary(lefthand) table.
- System.String foreignColumn - The fully-qualified column name or wildcard to use as the foreign(righthand) table.
###AddConstraint(System.String,System.String,Izenda.AdHoc.Database.DatabaseSchema)
Parameters:
- System.String dirtyPrimaryColumn
- System.String dirtyForeignColumn
- Izenda.AdHoc.Database.DatabaseSchema schema
###AddForcedLeftJoin(System.String,System.String) Represents a method to add a primary/foreign key relationship between two tables in the schema using a LEFT OUTER JOIN.
Parameters:
- System.String primaryTable - The fully-qualified table name to use as the primary(lefthand) table.
- System.String foreignTable - The fully-qualified table name to use as the foreign(righthand) table.
###AddForcedLeftJoin(System.String) Represents a method to add a primary/foreign key relationship between a table and itself in the schema using a LEFT OUTER JOIN.
Parameters:
- System.String table - The fully-qualified table name to use to join it to itself.
###BeginAddingMultipleConstraints()
###CheckConnection() Checks to ensure connectivity to the database
###ContainColumn(System.String,System.String,System.String) Represents a method to determine whether the specified table in the schema contains the column with the specified name.
Parameters:
- System.String schemaName - The name of the database schema to use.
- System.String tableName - The name of the table within the schema to use.
- System.String columnName - The name of the column to determine the existence of.
Returns:
True if the column was found on the database. False if not.
###ContainsTableName(System.String) Checks to see if the specified table exists on the database.
Parameters:
- System.String name - The name of the table to check for.
Returns:
A System.Boolean representation of the table's existence.
###ConvertToDbType(System.Type) Represents a method that gets the System.Data.SqlDbType that is type equivalent to the specified System.Type
Parameters:
- System.Type t - The System.Type to convert to a System.Data.SqlDbType
Returns:
The System.Data.SqlDbType produced from the specified System.Type
###CreateCommand(System.String)
Parameters:
- System.String sql
###CreateConnection() Represents a method that creates a connection to the database if the connection string exists.
###CreateDataAdapter(System.String) Represents a method that creates an executable System.Data.IDbDataAdapter for the specified command.
Parameters:
- System.String sql - The System.String representation of the SQL to use.
Returns:
The executable adapter.
###CreateDataAdapter(System.Data.IDbCommand) Represents a method that creates an executable System.Data.IDbDataAdapter for the specified command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand to use.
Returns:
The executable adapter.
###CreateJoinedTablesList(System.String[],Izenda.AdHoc.ReportSet) Represents a method that creates a collection of related tables from the provided array of datasources for determining possible relationships between datasources.
Parameters:
- System.String[] datasources
- Izenda.AdHoc.ReportSet rs
###CreateParameter(System.String,System.Object) Represents a method that creates a generically-typed System.Data.IDataParameter object from the specified values that can be typecast to a System.Data.IDataParameter object.
Parameters:
- System.String name - The name of the parameter.
- System.Object value - The value the parameter will have.
Returns:
The System.Data.IDataParameter created.
###CreateParameter(System.String,System.Object,System.Data.DbType) Represents a method that creates a generically-typed System.Data.IDataParameter object from the specified values that can be typecast to a System.Data.IDataParameter object.
Parameters:
- System.String name - The name of the parameter.
- System.Object value - The value the parameter will have.
- System.Data.DbType originalType - The System.Data.DbType to use for the parameter.
Returns:
The System.Data.IDataParameter created.
###DateTimeNow() Represents a method that gets the System.String representation of the MSSQL command to return the current system date from the database server.
Returns:
The System.String function for returning the current date.
###DeleteReportTemplate(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to delete the HTML form for the specified report from the database.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantId - The tenantID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to delete the form data.
###DeleteReportThumbnail(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to delete a report thumbnail image in the SavedReportsTable on the database.(deprecated)
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantId - The tenantID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to delete a thumbnail.
###DeleteThumbnail(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to delete a report thumbnail image in the SavedReportsTable on the database.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantID - The tenant ID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to delete a thumbnail.
###DetectVersion() Represents the method that is used to get the version of the database.
###EndAddingMultipleConstraints()
###EnsureCorrectMeta(System.String) Rrepresents a method that is used to create a clustered index on the specified table name if one doesn't exist.
Parameters:
- System.String tableName - The table to create an index on.
###Equals(System.Object)
Parameters:
- System.Object obj
###ExctractSchema() Represents a method that is used to obtain the database schema by populating the tables, views, stored procedures, and constraints.
Returns:
The Izenda.AdHoc.Database.DatabaseSchema object representing the collection of tables, views, stored procedures, and constraints.
###ExecuteDataSet(System.String) Gets a System.Data.DataSet object from the database using the SQL query provided.
Parameters:
- System.String sql - The System.String SQL query to execute.
Returns:
The System.Data.DataSet produced by the query from the database.
###ExecuteDataSet(System.String,System.Boolean) Gets a System.Data.DataSet object from the database using the SQL query provided.
Parameters:
- System.String sql - The System.String SQL query to execute.
- System.Boolean returnNull - Specifies whether an exception will cause the method to return null instead of the exception.
###ExecuteNonQuery(System.String) Executes the SQL query on the database server and produces its return code.
Parameters:
- System.String sql - The System.String SQL query to execute.
Returns:
The System.Int32 return code of the query.
###ExecuteNonQuery(System.Data.IDbCommand) Executes the SQL command on the database server and produces its return code.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand SQL command to execute.
Returns:
The System.Int32 return code of the command.
###ExecuteScalar(System.String) Gets the first result from executing the specified SQL System.String.
Parameters:
- System.String sql - he System.String representation of the query to execute.
Returns:
The first result from the executed scalar command.
###ExecuteScalar(System.String,System.Boolean) Gets the first result from executing the specified SQL System.String.
Parameters:
- System.String sql - The System.String representation of the query to execute.
- System.Boolean returnNull - Specifies whether an exception will cause the method to return null instead of the exception.
Returns:
The first result from the executed scalar command.
###FillDataSet(System.Data.DataSet,System.Data.IDbCommand) Represents a method that gets a System.Data.IDataReader object from the specified database command that can be typecast to a System.Data.IDbCommand.
Parameters:
- System.Data.DataSet ds
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute.
Returns:
The executed System.Data.IDataReader object.
###FullStoredProceduresList() Represents a method that gets a list of all stored procedures on the database.
Returns:
The Izenda.AdHoc.Database.StoredProcedure array corresponding to the stored procedures found.
###GenerateCommand(Izenda.AdHoc.Report,System.Boolean) Creates an System.Data.IDbCommand object from the specified Izenda.AdHoc.Report.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to generate a database command for.
- System.Boolean grandTotalCommand - Makes the database command a grand total command or not.
Returns:
The System.Data.IDbCommand that can be executed to get the report data.
###GenerateSQL(Izenda.AdHoc.Report,System.Boolean,System.String,out System.Collections.IList) Gets a SQL statement for the specified report with the option of including filter parameters in the output.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to generate the SQL for.
- System.Boolean includeParams - Specifies whether to include filter parameters as output. When false, filter parameters will be added to the SQL string.
- System.String sql - The output System.String representation of the SQL command to get the report data.
- out System.Collections.IList param - The output System.Collections.IList of parameters that are used as filters.
###GenerateSqlSafetyDescription(System.String) Represents a method that gets the SQL-safe System.String of the given description.
Parameters:
- System.String description - The alias of a column, table, or view that needs to be made SQL-safe.
Returns:
The System.String represetation of the description that has been made safe for executing.
###GenerateTotalsCommand(Izenda.AdHoc.Report,System.Int32) Gets a System.Data.IDbCommand that produces grand totals for the specified Izenda.AdHoc.Report.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report that will be used to generate the command for.
- System.Int32 firstIgnored - Specifies the index of the first column in the OrderBy clause that should be ignored.
Returns:
The System.Data.IDbCommand that produces grand totals.
###GenerateTotalsSQL(Izenda.AdHoc.Report,System.Boolean,System.String,out System.Collections.IList) Gets a SQL statement that generates subtotals for the specified report with the option of including filter parameters in the output.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to generate the SQL totals for.
- System.Boolean includeParams - Specifies whether to include filter parameters as output. When false, filter parameters will be added to the SQL string.
- System.String sql - The output System.String representation of the SQL totals command to get the report data.
- out System.Collections.IList param - The output System.Collections.IList of parameters that are used as filters.
###GetAggregateFunction(Izenda.AdHoc.StandardAggregateFunctionType,System.String) Gets the System.String representation of the SQL expression for the specified aggregate function using the input expression.
Parameters:
- Izenda.AdHoc.StandardAggregateFunctionType aggregateFunction - The Izenda.AdHoc.StandardAggregateFunctionType to get the SQL for.
- System.String sqlExpression - The System.String input expression to apply the aggregate function to.
Returns:
The System.String representation of the entire aggregate function expression.
###GetAllStoredProcedures() Represents a method that gets a list of all stored procedures on the database from the VisibleDataSources.
Returns:
The Izenda.AdHoc.Database.StoredProcedure array corresponding to the stored procedures found.
###GetAllTables() Represents a method that gets a list of all tables and views on the database from the VisibleDataSources.
Returns:
The Izenda.AdHoc.Database.Table array corresponding to the tables and views found.
###GetAppropriateSqlTypeFromTypeGroup(Izenda.AdHoc.Database.SqlTypeGroup)
Parameters:
- Izenda.AdHoc.Database.SqlTypeGroup sqlTypeGroup
###GetBlankKeyword() Represents the keyword signifying NULLs or BLANK on the database.
Returns:
The symbol signifying NULL or BLANK
###GetColumns(Izenda.AdHoc.Database.Table) Represents a method that gets the complete list of columns found on the database for the specified table.
Parameters:
- Izenda.AdHoc.Database.Table table - The Izenda.AdHoc.Database.Table to find columns for.
Returns:
The Izenda.AdHoc.Database.Column array corresponding to the columns found.
###GetColumns(Izenda.AdHoc.Database.StoredProcedure) Represents a method that gets the list of columns for the specified stored procedure on the database.
Parameters:
- Izenda.AdHoc.Database.StoredProcedure storedProcedure - The Izenda.AdHoc.Database.StoredProcedure to get the returned columns for.
Returns:
The Izenda.AdHoc.Database.Column array corresponding to the columns found.
###GetColumnValuesSql(Izenda.AdHoc.Database.Column,System.Int32,System.String)
Parameters:
- Izenda.AdHoc.Database.Column dbColumn
- System.Int32 maxRowCount
- System.String startWithValue
###GetConcatStringsExpression(System.String,System.String,System.String) Represents a method that gets the System.String of an expression to concatenate three strings.
Parameters:
- System.String expression1 - The first expression to concatenate.
- System.String expression2 - The second expression to concatenate.
- System.String expression3 - The third expression to concatenate.
Returns:
The System.String representation of the SQL statement that can be executed to concatenate strings.
###GetConcatStringsExpression(System.String,System.String) Represents a method that gets the System.String of an expression to concatenate two strings.
Parameters:
- System.String expression1 - The first expression to concatenate.
- System.String expression2 - The second expression to concatenate.
Returns:
The System.String representation of the SQL statement that can be executed to concatenate strings.
###GetConstraints(Izenda.AdHoc.Database.DatabaseSchema) GRepresents a method that gets a list of constraints for the specified database schema on the database.
Parameters:
- Izenda.AdHoc.Database.DatabaseSchema schema - The Izenda.AdHoc.Database.DatabaseSchema to get the constraints for.
Returns:
The Izenda.AdHoc.Database.Constraint array corresponding to the database constraints found.
###GetCreateArchiveTableCommand(System.String) Gets the System.String SQL statement to create a table with the specified name to be used as the archived reports table.
Parameters:
- System.String tableName - The name of the table to create.
Returns:
The complete command to be executed.
###GetCreateDateExpression(System.String,System.String,System.String) Represents a method that gets the System.String of the function used to convert the specified parameters into a date.
Parameters:
- System.String yearExp - The year portion of the date.
- System.String monthExp - The month portion of the date.
- System.String dayExp - The day portion of the date.
Returns:
The SQL statement that can be executed to construct a formatted date from the parts provided.
###GetCreateReportCommand(System.String,System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to create a report on the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be created on the database.
- System.String tenantId - The tenant ID that the report should belong to when it's created.
- System.String xml - The XML report representation of the report definition.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetCreateReportCommand(System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to create a report on the database. This method uses an empty tenantId.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be created on the database.
- System.String xml - The XML report representation of the report definition.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetDatabase()
###GetDataReader(System.Data.IDbCommand)
Parameters:
- System.Data.IDbCommand command
###GetDataSet(System.Data.IDbCommand) Gets a System.Data.DataSet for the specified SQL command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand that will be evaluated and executed.
Returns:
The new System.Data.DataSet with the results of the query.
###GetDataSet(System.Data.IDbCommand,System.String) Gets a System.Data.DataSet for the specified SQL command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand that will be evaluated and executed.
- System.String reportPart - The System.String designation for the portion of the report this query relates to.
Returns:
The new System.Data.DataSet with the results of the query.
###GetDataSetCached(System.String) Gets a System.Data.DataSet for the specified SQL expression from the cache if possible. CacheQueries must be on, otherwise the query will touch the database instead.
Parameters:
- System.String sql - The System.String representation of the query to execute.
Returns:
The System.Data.DataSet that was cached the first time the query was executed or a new System.Data.DataSet with the results.
###GetDataSetCached(System.Data.IDbCommand) Gets a System.Data.DataSet for the specified SQL command from the cache if possible. CacheQueries must be on, otherwise the query will touch the database instead.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand that will be evaluated and executed if the underlying SQL is not cached.
Returns:
The System.Data.DataSet that was cached the first time the query was executed or a new System.Data.DataSet with the results.
###GetDataSetCached(System.Data.IDbCommand,System.Boolean) Gets a System.Data.DataSet for the specified SQL command with the option of using the cached version.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand that will be evaluated and executed if the underlying SQL is not cached.
- System.Boolean cache - Specifies whether to use the cached System.Data.DataSet when possible. This depends on the QueryCachingTime.
Returns:
The System.Data.DataSet that was cached the first time the query was executed or a new System.Data.DataSet with the results.
###GetDataTable(System.String,System.Boolean) Gets the first System.Data.DataTable in the DataSet returned from executing the SQL.
Parameters:
- System.String sql - The System.String representation of the query to execute.
- System.Boolean cache - Specifies whether to use the cached System.Data.DataSet when possible. This depends on the QueryCachingTime.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDataTable(System.String) Gets the first System.Data.DataTable in the DataSet returned from executing the SQL. The results are loaded from the cache if possible when CacheQueries is on.
Parameters:
- System.String sql - The System.String representation of the query to execute.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDataTable(System.Data.IDbCommand,System.Boolean) Gets the first System.Data.DataTable in the DataSet returned from executing the SQL command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute.
- System.Boolean cache - Specifies whether to use the cached System.Data.DataSet when possible. This depends on the QueryCachingTime.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDataTable(System.Data.IDbCommand,System.String) Gets the first System.Data.DataTable in the DataSet returned from executing the SQL command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute.
- System.String reportPart - The System.String designation for the portion of the report this query relates to.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDataTable(System.Data.IDbCommand) Gets the first System.Data.DataTable in the DataSet returned from executing the SQL command.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDataTable(Izenda.AdHoc.Report,System.Data.IDbCommand) Gets a System.Data.DataTable from the specified Izenda.AdHoc.Report and System.Data.IDbCommand provided.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report that corresponds to the database command
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute on the database.
Returns:
The first System.Data.DataTable found on the System.Data.DataSet returned by the query.
###GetDateAdd(System.String,System.Int32,System.String) Gets a formatted System.String that constructs a SQL statement to add the specified value to the dateTime provided.
Parameters:
- System.String dateTime - The base SQL formatted date to begin with.
- System.Int32 addedValue - The value to add to the date.
- System.String addedMeasure - The SQL keyword for the interval you want to specify to add.
Returns:
The SQL formatted System.String constructed from the parts.
###GetDateAdd(System.String,System.Double,System.String)
Parameters:
- System.String dateTime
- System.Double addedValue
- System.String addedMeasure
###GetDateDiffSQL(System.String,System.String,Izenda.AdHoc.StandardAggregateFunctionType) Represents a method that gets the difference in days between the two dates using the specified aggregation function.
Parameters:
- System.String date1 - The System.String representation of the date to be the subtrahend of the expression.
- System.String date2 - The System.String representation of the date to be the minuend of the expression.
- Izenda.AdHoc.StandardAggregateFunctionType funcType - The Izenda.AdHoc.StandardAggregateFunctionType to apply to the statement after the difference is calculated.
Returns:
The System.String representation of the completed function to calculate the difference in days between dates.
###GetDateDiffSQL(System.String,System.String,System.String,Izenda.AdHoc.StandardAggregateFunctionType) Represents a method that gets the difference between the two dates using the specified aggregation function.
Parameters:
- System.String date1 - The System.String representation of the date to be the subtrahend of the expression.
- System.String date2 - The System.String representation of the date to be the minuend of the expression.
- System.String measure - The SQL keyword for the interval you want to specify to add.
- Izenda.AdHoc.StandardAggregateFunctionType funcType - The Izenda.AdHoc.StandardAggregateFunctionType to apply to the statement after the difference is calculated.
Returns:
The System.String representation of the completed function to calculate the difference between dates for the interval specified.
###GetDateExpression(System.DateTime) Represents a method that gets the System.String of the specified System.DateTime formatted into a datetime format specific to the database system.
Parameters:
- System.DateTime date - The System.DateTime that will be expressed as a string.
Returns:
The System.String representation of the date.
###GetDateNameExpression(System.String,System.String) Represents a method that gets the System.String of the specified date part and SQL expression formatted to be executed in SQL.
Parameters:
- System.String part - The date function to convert the expression into.
- System.String expression - The expression that should be modified by the date function built by this method
Returns:
The System.String representation of the completed expression.
###GetDatePartExpression(System.String,System.String) Represents a method that gets the System.String of the specified date part and SQL expression formatted to be executed in SQL.
Parameters:
- System.String part - The date function to convert the expression into.
- System.String expression - The expression that should be modified by the date function built by this method
Returns:
The System.String representation of the completed expression.
###GetDeleteReportSetCommand(System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to delete the specified report definition from the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be deleted from the database.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetDeleteReportSetCommand(System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to delete the specified report definition from the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be deleted from the database.
- System.String tenantId - The tenant ID that the report was saved with.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetDomainFunction() Represents a method that is used to get the SQL function that will be used for joining tables with web addresses.
Returns:
The System.String representation of the name of the SQL function if the DBMS supports it, or an exception if not.
###GetFieldsInfo(System.String)
Parameters:
- System.String fullDsName
###GetGetReportSQL(System.String)
Parameters:
- System.String tableName
###GetHashCode()
###GetInstance()
###GetIsNullSqlForStringColumn(System.String) Represents a method that gets the System.String of an Oracle statement that will check if the input statement is null.
Parameters:
- System.String columnSql - The column statement to check for nulls.
Returns:
The System.String statement that can be executed.
###GetLikeExpression(System.String,System.String) Represents a method that gets a SQL formatted LIKE statement between the given values.
Parameters:
- System.String column - The column to have its values compared for matches.
- System.String value - The value to compare to the column value for matches.
Returns:
The System.String representation of the SQL formatted LIKE statement.
###GetListReportsCommand(System.String,System.DateTime,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to get a list of reports from the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.DateTime lastModified - The System.DateTime that marks the earliest date to look for when obtaining reports
- System.String tenantId - The tenant ID to get the saved reports for.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetLoadReportSetCommand(System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to load the specified report definition from the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be loaded from the database.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetLoadReportSetCommand(System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to load the specified report definition with the specified name and tenantId from the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be loaded from the database.
- System.String tenantId - The tenant ID that the report was saved with.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetMinMax(System.Collections.Generic.IDictionary>,out System.DateTime,out System.DateTime) Gets the minimum and maximum System.DateTime values from a collection of date columns across various tables.
Parameters:
- System.Collections.Generic.IDictionary<System.String,System.Collections.Generic.IList<System.String>> dateTimeColumns - The System.Collections.Generic.IDictionary collection of table keys and column values to check.
- out System.DateTime minDate - The minimum System.DateTime that was found across all columns in the collection of tables.
- out System.DateTime maxDate - The maximum System.DateTime that was found across all columns in the collection of tables.
###GetNoLockSql() Represents the DBMS's NOLOCK statement, if one exists for the DBMS.
###GetNumericColumnRoundSQL(System.String) Represents a method that gets a SQL formatted function to ROUND a numeric column.
Parameters:
- System.String nativeColumnSql - The SQL statement or column to ROUND.
Returns:
The System.String representation of the SQL statement or column with the applied ROUND function.
###GetObjectIdAndTypeSql(System.String,System.Boolean) Gets a System.String representation of an Oracle command that gets the id and type of the specified object.
Parameters:
- System.String objectName - The name of the object to look for.
- System.Boolean isStandard - A System.Boolean representing whether the object being searched for is an Oracle standard object or a user object. When true, the statement will require administrator privileges.
Returns:
The System.String representation of the database command to get an object ID and its type.
###GetObjectMetaSql(System.String,System.Boolean) Gets the System.String representation of an database command that obtains metadata information about the object with the specified ID.
Parameters:
- System.String objectID - The name of the object to look for.
- System.Boolean isStandard - A System.Boolean representing whether the object being searched for is a standard database object or a user object. When true, the statement will require administrator privileges.
Returns:
The System.String representation of the command that gets the metadata for the object with the specified ID.
###GetObjectSchemaSql(System.String) Gets the System.String representation of a command that selects the database schema(owner) of the object with the specified name.
Parameters:
- System.String objectName - The name of the object to look for.
Returns:
The System.String representation of the database command to get the schema of the object.
###GetParamFilters(Izenda.AdHoc.Report) Gets a collection of all the filters in a report that are parameters for stored procedures.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to find the paramter filters for.
Returns:
The Izenda.AdHoc.FilterCollection containing all the filters that are stored procedure parameters.
###GetParams(Izenda.AdHoc.Database.StoredProcedure)
Parameters:
- Izenda.AdHoc.Database.StoredProcedure storedProcedure
###GetQuarterNumberExpresion(System.String) Represents a method that gets the System.String of a DATEPART function to extract the quarter number from the specified SQL expression.
Parameters:
- System.String expression - The MSSQL System.String that the quarter should be extracted from.
Returns:
The SQL formatted System.String that can be executed to extract the quarter of the year from the expression.
###GetReportInfo(System.Data.DataRow,System.String,System.Boolean) Creates a new Izenda.AdHoc.ReportInfo object from the parameters provided.
Parameters:
- System.Data.DataRow row - The System.Data.DataRow that will be used to populate the report's information. The columns required are the columns in the SavedReportsTable
- System.String currentUserTenantId - The tenant ID of the currently active user.
- System.Boolean useReportId - Determines whether to use the report name or the report ID to identify which report to get the info for.
Returns:
The Izenda.AdHoc.ReportInfo object containing information about the report.
###GetReportInfo(System.Data.DataRow) Returns a new Izenda.AdHoc.ReportInfo object from the specified System.Data.DataRow that contains data relevant to constructing the object.
Parameters:
- System.Data.DataRow row - The System.Data.DataRow from which the Izenda.AdHoc.ReportInfo will be generated. Certain columns are expected relating to the SavedReportsTable columns.
Returns:
A new Izenda.AdHoc.ReportInfo object built from the System.Data.DataRow.
###GetReportStoredProcedures(Izenda.AdHoc.Report) Gets a collection of Izenda.AdHoc.Database.Table objects that represent the stored procedures included on the report.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to be checked for stored procedure datasources.
Returns:
A list of Izenda.AdHoc.Database.Table objects corresponding to the stored procedures found on the report.
###GetReportTemplate(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to get the HTML form for the specified report from the database.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantId - The tenantID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to get the form data.
###GetReportThumbnail(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to get the binary thumbnail data for the specified report from the database.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantId - The tenantID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to obtain the thumbnail.
###GetScalar(System.Data.IDbCommand) Gets the first result from executing the specified SQL System.Data.IDbCommand.
Parameters:
- System.Data.IDbCommand command - The System.Data.IDbCommand object to execute.
Returns:
The first result from the executed scalar command.
###GetScalar(System.String) Gets the first result from executing the specified SQL System.String.
Parameters:
- System.String sql - The System.String representation of the query to execute.
Returns:
The first result from the executed scalar command.
###GetSchemaInfo(System.Boolean,System.Boolean) Represents a method to obtain an array of Izenda.AdHoc.Webservices.DataBaseInfo objects from a single database or multiple databases. Multiple databases are only supported when using Fusion.
Parameters:
- System.Boolean useSingleDatabaseForFusionDriver - Specifies whether to categorize all tables and columns under a category called "Single Database" or to obtain category information from the DataSourceCategories collection.
- System.Boolean lazy
Returns:
The collection of Izenda.AdHoc.Webservices.DataBaseInfo objects corresponding to all tables, views, stored procedures, constraints, and columns in the database schema with category information.
###GetSqlName(System.String,Izenda.AdHoc.Database.Column)
Parameters:
- System.String tableAlias
- Izenda.AdHoc.Database.Column column
###GetSqlName(Izenda.AdHoc.Database.StoredProcedure)
Parameters:
###GetSqlName(Izenda.AdHoc.Database.Table) Represents a method that gets the System.String representation of the fully-qualified name of the table formatted for the specified database.
Parameters:
- Izenda.AdHoc.Database.Table table - The Izenda.AdHoc.Database.Table to get the fully-qualified name of.
Returns:
The System.String representation of the table name.
###GetSqlName(Izenda.AdHoc.Database.Column) Represents a method that gets the System.String of the fully-qualified name of the column formatted for the specified database.
Parameters:
- Izenda.AdHoc.Database.Column column - The Izenda.AdHoc.Database.Column to get the fully-qualified name of.
Returns:
The System.String representation of the column name.
###GetSqlTypeByDbType(System.String) Represents a method that gets an Izenda.AdHoc.Database.SqlType object from the specified database type string if it exists in the list of registered types.
Parameters:
- System.String dbType - The System.String representation of the database type to check for.
Returns:
The Izenda.AdHoc.Database.SqlType that was found.
###GetStoredProceduresCommand(Izenda.AdHoc.Report,System.Collections.Generic.List,System.Data.IDbCommand,System.String,System.Boolean,System.Boolean,out System.Boolean,out System.Boolean) Gets a System.Data.IDbCommand that contains the SQL generated for a report containing stored procedures.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report to have a query generated for.
- System.Collections.Generic.List<Izenda.AdHoc.Database.Table> storedProceduresTables - The Izenda.AdHoc.Database.Table list of all the stored procedure tables the report contains.
- System.Data.IDbCommand command - The System.Data.IDbCommand SQL command that was generated by the report's default SQL property.
- System.String uniqueID - The System.String representation of a value that will be used to generate unique IDs for creating temp tables containing the executed stored procedure results.
- System.Boolean forceFullStructure - Whether always use "full" Stired Procedures execution format. Usually this involves temporary tables creation.
- System.Boolean shortSpExec - A System.Boolean indicating whether the command generated uses the simple method of executing the stored procedure command or the complex method. The complex method is used when joining stored procedures to other tables, or in-query calculations like arithmetic or expressions present. Simple mode also does not permit field descriptions to be applied.
- out System.Boolean someFiltersNotSpecified - A System.Boolean indicating whether any filters on the report were not defined at the report level. The report is cross-referenced with the CurrentReportSet to determine this.
- out System.Boolean columnsReorderingRequired - A System.Boolean indicating whether the System.Data.DataTable produced from executing the command will require its columns to be re-ordered after the fact to match the DataTable's order to the report's order.
Returns:
A System.Data.IDbCommand that can be executed to obtain the data for the stored procedure report.
###GetStringConst(System.String)
Parameters:
- System.String stringConst
###GetTemporaryColumnByName(System.String)
Parameters:
- System.String name
###GetTemporaryTableByName(System.String)
Parameters:
- System.String name
###GetTextBracket() Gets the database field delimiter character.
Returns:
The character that is used to delimit identifiers on the database.
###GetTimeSum(System.String) Gets a formatted System.String that constructs a SQL statement to get the aggregate sum of the SQL time expression.
Parameters:
- System.String innerSQL - The SQL statement that produces a SQL date expression to construct a time period from.
Returns:
The sum of time that has elapsed since January 1, 1900 until the specified date.
###GetTopNSql(System.String,System.Int32) Represents a method that creates a TOP statement to be used with the specified SQL expression to select the number of records specified.
Parameters:
- System.String sql - The SQL statement that will receive the TOP statement.
- System.Int32 n - The number of records to fetch with this TOP statement.
Returns:
The System.String SQL statement with the appended TOP n records.
###GetToStringExpression(System.String) Represents a method that gets the System.String of the specified SQL expression CAST to a string.
Parameters:
- System.String expression - The SQL expression that should be cast to a string type.
Returns:
The System.String representation of the SQL statement.
###GetType()
###GetUpdateReportCommand(System.String,System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to update a report on the database.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be updated on the database.
- System.String tenantId - The tenant ID that the report should belong to when it's updated.
- System.String xml - The XML report representation of the report definition.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetUpdateReportCommand(System.String,System.String,System.String) Represents a method that gets a SQL command from the specified parameters that creates a System.Data.IDbCommand to update a report on the database. This method uses an empty tenantId.
Parameters:
- System.String tableName - The name of the table used to store reports.
- System.String reportName - The name of the report that will be updated on the database.
- System.String xml - The XML report representation of the report definition.
Returns:
The System.Data.IDbCommand created from the parameters.
###GetUserTables() Represents a method that gets a list of all tables and views on the database available to the user(schema) specified in the connection string.
Returns:
The Izenda.AdHoc.Database.Table array corresponding to the tables and views found.
###GetWeekNumberExpression(System.String) Represents a method that gets the System.String of a function to extract the week from the specified SQL expression.
Parameters:
- System.String expression - The System.String that the week should be extracted from.
Returns:
The SQL formatted System.String that can be executed to extract the week portion from the expression.
###GetYearAndWeekExpression(System.String) Represents a method that gets the System.String of an MSSQL function to extract the year and week from the specified SQL expression.
Parameters:
- System.String expression - The MSSQL System.String that the year and week should be extracted from.
Returns:
The SQL formatted System.String that can be executed to extract the year and week portion from the expression.
###InvalidateDatasourcesInSchemaCache(System.String[]) Represents a method to invalidate specific datasources in schema cache.
Parameters:
- System.String[] datasources
###InvalidateQueryCache() Represents a method to remove queries from the application's in-memory cache.
###InvalidateSchemaCache() Represents a method to remove the schema from the application's in-memory cache.
###IsJoinAllowable(Izenda.AdHoc.Database.SqlType,Izenda.AdHoc.Database.SqlType) Represents a method that determines whether two tables' Izenda.AdHoc.Database.SqlTypes are compatible to join the tables.
Parameters:
- Izenda.AdHoc.Database.SqlType type1 - The first Izenda.AdHoc.Database.SqlType to check for join compatibility.
- Izenda.AdHoc.Database.SqlType type2 - The second Izenda.AdHoc.Database.SqlType to check for join compatibility.
Returns:
True if the types are compatible, false if not.
###IsStandardFunctionsAvailable() Determines whether Oracle standard functions are available to query and obtain metadata for.
Returns:
A System.Boolean representing whether standard functions are available or not.
###isUserFunction(System.String) Determines whether the object with the specified name is a user function or a system function for the specified database object.
Parameters:
- System.String objectName - The name of the database object to find on the database.
Returns:
A System.Boolean returned from executing the database command.
###ParameterName(System.String) Represents a method that gets the System.String for the specified parameter name formatted for the specified database.
Parameters:
- System.String name - The name of the parameter.
Returns:
The formatted parameter name.
###PrepareData(Izenda.AdHoc.Report) Represents a method that can be used to pre-process the report before the results are obtained from the database and the data is formatted.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report that is to be processed.
###PrepareForArithmeticOperation(System.String)
Parameters:
- System.String expression
###PrepareForArithmeticOperation(System.String,Izenda.AdHoc.Database.SqlTypeGroup) Represents a method that safely converts the expression into a database type that can receive arithmetic operations.
Parameters:
- System.String expression - The System.String representation of the SQL column or expression to prepare.
- Izenda.AdHoc.Database.SqlTypeGroup typeGroup - The Izenda.AdHoc.Database.SqlTypeGroup to attempt to CAST to. Certain database types cannot be cast to for this purpose.
Returns:
The SQL formatted expression that allows arithmetic operations to be performed on it.
###RemoveConstraint(System.String,System.String) Represents a method that removes a primary/foreign key relationship between two tables' columns in the schema. Wildcards are not accepted and column names are case sensitive.
Parameters:
- System.String fullyQualifiedPrimaryColumn - The fully-qualified column name or wildcard to use as the primary(lefthand) table.
- System.String fullyQualifiedForeignColumn - The fully-qualified column name or wildcard to use as the foreign(righthand) table.
Returns:
True when the constraint was removed. When it could not be found or removed, this is false.
###RemoveConstraint(System.String,System.String,Izenda.AdHoc.Database.DatabaseSchema) Represents a method that removes a primary/foreign key relationship between two tables' columns in the schema. Wildcards are not accepted and column names are case sensitive.
Parameters:
- System.String fullyQualifiedPrimaryColumn - The fully-qualified column name or wildcard to use as the primary(lefthand) table.
- System.String fullyQualifiedForeignColumn - The fully-qualified column name or wildcard to use as the foreign(righthand) table.
- Izenda.AdHoc.Database.DatabaseSchema schema - A Izenda.AdHoc.Database.DatabaseSchema object representing a schema from which constraint should be removed.
Returns:
True when the constraint was removed. When it could not be found or removed, this is false.
###StringToSqlName(System.String) Represents a method that gets the System.String of the specified value that will be formatted to be acceptible as an identifier.
Parameters:
- System.String str - The table, view, or column name to be formatted as an identifier
Returns:
The value specified with the identifier notation of the database.
###StringToSqlNameBySafetyDescription(System.String) Represents a method that gets the System.String of the specified value that will be formatted to be acceptible as an identifier.
Parameters:
- System.String str - The table, view, or column name to be formatted as an identifier
Returns:
The value specified with the identifier notation of the database.
###ToString()
###UnPrepareData(Izenda.AdHoc.Report) Represents a method that can be used to post-process the report after the results are obtained from the database and the data is formatted.
Parameters:
- Izenda.AdHoc.Report report - The Izenda.AdHoc.Report that was processed.
###UpdateForm(System.String,System.String,System.String,System.String) Updates the database table where reports are stored with the System.String representation of the HTML form used for the specified report.
Parameters:
- System.String tableName - The name of the database table that holds saved reports.
- System.String reportName - The name of the report that the HTML form belongs to.
- System.String form - The System.String representation of the HTML form that is to be saved with the report.
- System.String tenantID - The tenantID that the report belongs to.
###UpdateThumbnail(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to update a report thumbnail image in the SavedReportsTable on the database. When the command is created, set @param0 to the thumbnail image.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantID - The tenantID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to update a thumbnail.
###VerifyThumbnail(System.String,System.String) Creates a System.Data.IDbCommand that can be executed to find whether the specified report on the database has a thumbnail for it.
Parameters:
- System.String reportName - The name of the report that the thumbnail belongs to.
- System.String tenantID - The tenant ID that the report belongs to.
Returns:
A System.Data.IDbCommand that can be used to verify a thumbnail exists for a report.
