umbraco.DataLayer
The DataLayerHelper class is the main interface to the data layer.
Name of the property that identifies the SQL helper type.
Name of the default data layer, that is used when nothing is specified.
Format used when the SQL helper is qualified by its simple name, instead of the full class name.
Creates a SQL helper for the specified connection string.
The connection string containing the SQL helper type.
A new SQL helper.
This method will change to allow the addition of external SQL helpers.
Interface for an extension to an .
Called when ExecuteScalar is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteNonQuery is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteXmlReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Extension to that logs all executed commands to a stream.
Format of a line in the log file.
Stream to which the commands are logged.
Parser used to inline query parameters.
Initializes a new instance of the class.
The input stream to which the commands will be logged.
Initializes a new instance of the class.
The name of the file in which the commands will be logged.
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
Called when ExecuteScalar is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteNonQuery is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteXmlReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Appends a command to the log stream.
The SQL helper executing the command.
The command text.
The parameters.
Class that adds extensions to an existing SQL helper.
Decorator design pattern.
SQL helper this SqlHelperExtender extends.
Extensions that are currently in use.
Gets the connection string.
The connection string.
Gets the Umbraco utility associated with this SQL helper.
The utilities.
Initializes a new instance of the class.
The SQL helper.
Initializes a new instance of the class.
The SQL helper.
The extensions.
Adds the extension to the extension chain.
The extension.
Removes an extension from the extension chain.
The extension.
Creates a new parameter for use with this specific implementation of ISqlHelper.
Name of the parameter.
Value of the parameter.
A new parameter of the correct type.
Abstract factory pattern
Creates a concatenation fragment for use in an SQL query.
The values that need to be concatenated
The SQL query fragment.
SQL Server uses a+b, MySql uses concat(a,b), Oracle uses a||b...
Escapes a string for use in an SQL query.
The text to be escaped.
The escaped value.
You should use SQL parameters instead.
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
Executes a command that returns a single value.
The type of the value.
The command text.
The parameters.
The return value of the command.
If a data source error occurs.
Executes a command that returns an XML value.
The command text.
The parameters.
An XML reader containing the return value.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Abstract base class for an SQL helper extension.
Implements all methods with an empty body.
You will find it convenient to use this class as a base for most extensions,
because you only have to override the functions you actually use.
Called when ExecuteScalar is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteNonQuery is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Called when ExecuteXmlReader is executed.
The SQL helper.
The command text.
The SQL parameters.
Represents an object that reads record data from a result set.
Gets a value indicating whether this instance has records.
true if this instance has records; otherwise, false.
Advances to the next record.
true if there are more records; otherwise, false.
Closes the reader.
Determines whether a field with the specified field name exists in the record.
The field can still contain a null value.
Name of the field.
true if the specified field exists; otherwise, false.
Determines whether the specified field is null.
Name of the field.
true if the specified field is null; otherwise, false.
Gets the specified field value.
The field type.
Name of the field.
Gets the value of the specified field.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a bool.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a byte.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a DateTime.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a decimal.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a double.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a float.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a Guid.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a short.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as an int.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a long.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a string.
Name of the field.
The value of the field.
No column with the specified name was found.
Interface of a module that interacts with a certain type of SQL database.
Gets the connection string.
The connection string.
Gets the Umbraco utility associated with this SQL helper.
The utilities.
Creates a new parameter for use with this specific implementation of ISqlHelper.
Name of the parameter.
Value of the parameter.
A new parameter of the correct type.
Abstract factory pattern
Escapes a string for use in an SQL query.
The value.
The escaped value.
You should use parameters instead.
Creates a concatenation fragment for use in an SQL query.
The values that need to be concatenated
The SQL query fragment.
SQL Server uses a+b, MySql uses concat(a,b), Oracle uses a||b...
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
If a data source error occurs.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
If a data source error occurs.
Executes a command that returns a single value.
The type of the value.
The command text.
The parameters.
The return value of the command.
If a data source error occurs.
Executes a command that returns an XML value.
The command text.
The parameters.
An XML reader containing the return value.
If a data source error occurs.
Interface for an that wraps around a .
Data type of the wrapped parameter.
Gets the original parameter.
The original parameter.
Exception generated in an SQL helper.
Initializes a new instance of the class.
The method where the exception occurred.
The command text. Only used in debug mode.
The command parameters. Only used in debug mode.
The inner exception.
*Never* place the command text inside the exception message,
since the message could be shown on a level with lower security.
Especially dangerous with faulty command texts (code injection),
or commands with inline parameters. (information leak)
(So there's another reason to use real parameters.)
Database installer for an MySql data source.
The latest database version this installer supports.
The specifications to determine the database version.
Gets a value indicating whether the installer can upgrade the data source.
true if the installer can upgrade the data source; otherwise, false.
Empty data sources can't be upgraded, just installed.
Gets the version specification for evaluation by DetermineCurrentVersion.
Only first matching specification is taken into account.
The version specifications.
Initializes a new instance of the class.
The SQL helper.
Returns the sql to do a full install
Returns the sql to do an upgrade
Converts the SQL command to the MySQL 4.x dialect.
The SQL in MySQL 5+ dialect.
The SQL in MySQL 4.x dialect.
Gets the MySQL major version number.
The MySQL major version number
Object that performs parsing tasks on a MySQL command.
Initializes a new instance of the class.
Parses the query, performing provider specific changes.
The query.
The modified query.
Uppercases identifiers and replaces their tokens.
Utility for an MySql data source.
Initializes a new instance of the class.
The SQL helper.
Creates an installer.
The MySql installer.
Class that adapts a MySql.Data.MySqlClient.MySqlDataReader to a RecordsReaderAdapter.
Initializes a new instance of the class.
The data reader.
Gets a value indicating whether this instance has records.
true if this instance has records; otherwise, false.
Sql Helper for a MySQL 5.0 database.
SQL parser that replaces the SQL-Server specific tokens by their MySQL equivalent.
Initializes a new instance of the class.
The connection string.
Creates a new parameter for use with this specific implementation of ISqlHelper.
Name of the parameter.
Value of the parameter.
A new parameter of the correct type.
Abstract factory pattern
Converts a the command before executing.
The command text.
The original command text.
Executes a command that returns a single value.
The command text.
The parameters.
The return value of the command.
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
Converts the scalar value to the given type.
Desired type of the value.
A scalar returned by ExecuteScalar.
The scalar, converted to type T.
Creates a concatenation fragment for use in an SQL query.
The values that need to be concatenated
The SQL query fragment.
SQL Server uses a+b, MySql uses concat(a,b), Oracle uses a||b...
Parameter class for the MySqlHelper.
Initializes a new instance of the class.
Name of the parameter.
Value of the parameter.
Changes the parameter name to the MySQL equivalent.
The name of the parameter, preceded by an at sign.
The name of the parameter, preceded by a question mark.
SQL Server implementation of .
Initializes a new instance of the class.
The SQL helper.
Gets the table with the specified name.
The name.
The table, or null if no table with that name exists.
Saves or updates the table.
The table to be saved.
Creates the table in the data source.
The table.
Creates a new column in the table.
The table.
The field used to create the column.
Gets the .Net type corresponding to the specified database data type.
The data type reader.
The .Net type
Gets the database type corresponding to the field, complete with field properties.
The field.
The database type.
Gets the name of the database type, without field properties.
The field.
Database installer for an SQL Server data source.
The latest database version this installer supports.
The specifications to determine the database version.
Gets a value indicating whether the installer can upgrade the data source.
true if the installer can upgrade the data source; otherwise, false.
Empty data sources can't be upgraded, just installed.
Gets the version specification for evaluation by DetermineCurrentVersion.
Only first matching specification is taken into account.
The version specifications.
Initializes a new instance of the class.
The SQL helper.
Returns the sql to do a full install
Returns the sql to do an upgrade
Utility for an SQL Server data source.
Initializes a new instance of the class.
The SQL helper.
Creates an installer.
The SQL Server installer.
Creates a table utility.
The table utility
Class that adapts a SqlDataReader.SqlDataReader to a RecordsReaderAdapter.
Initializes a new instance of the class.
The data reader.
Gets a value indicating whether this instance has records.
true if this instance has records; otherwise, false.
Sql Helper for an SQL Server database.
Initializes a new instance of the class.
The connection string.
Creates a new parameter for use with this specific implementation of ISqlHelper.
Name of the parameter.
Value of the parameter.
A new parameter of the correct type.
Abstract factory pattern
Executes a command that returns a single value.
The command text.
The parameters.
The return value of the command.
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
Parameter class for the SqlServerHelper.
Initializes a new instance of the class.
Name of the parameter.
Value of the parameter.
Object that performs parsing tasks on an SQL command.
Original tokens for query token replacement.
Destination tokens for query token replacement.
Gets the character strings are surrounded with.
The string delimiter.
Gets the param character parameters start with.
The parameter starting token.
Initializes a new instance of the class.
Initializes a new instance of the class
that performs the specified token translation.
The original tokens.
The new tokens, each token corresponds with the item of
srcTokens at the same index.
Parses the query, performing provider specific changes.
The query.
The modified query.
The default implementation returns the original query.
Overriding classes can change this behavior.
Replaces parameters in a query by their values.
The command text.
The parameters.
The query, with parameter placeholders replaced by their values.
Replaces tokens before or after identifiers in a query string.
The original query.
The query with replaced identifier tokens.
Assumes a correct query.
Uppercases the identifiers in the query, leaving strings untouched.
The query.
The query with uppercased identifiers.
Searches the position in a query where a string is terminated.
The query to search.
The position of the opening quote of the string.
The position of termination quote of the string.
Assumes a correct query, 0<startPos<query.Length-1 and query[startPos]=='\''.
(because the function is optimized for speed)
If the query is incorrect,
startPos not in ]0,query.Length-1[ or query[startPos]!='\''.
This trims all white spaces from beginning and end of the string and removes any line breaks (repacing with a space)
Base class for utilities that use an ISqlHelper as data source.
The SQL helper type.
SQL helper the utility uses as data source.
Gets the SQL helper.
The SQL helper.
Initializes the with the specified SQL helper.
The SQL helper.
Version number of an Umbraco database.
Database connection unsuccessful.
Empty database, connection successful.
Umbraco version 3.0.
Umbraco version 4.0.
Umbraco version 4.1.
Umbraco version 4.8.
Base class for installers that use an ISqlHelper as data source.
The SQL helper type.
The latest available version this installer provides.
The currently installed database version, null if undetermined.
Regular expression that finds multiline block comments.
Gets the current data source version.
The current version.
Gets the latest available version.
The latest version.
Gets a value indicating whether this installer can connect to the data source.
true if the installer can connect; otherwise, false.
Gets a value indicating whether the data source is empty and ready for installation.
true if the data source is empty; otherwise, false.
Gets a value indicating whether the data source has an up to date version.
true if the data source is up to date; otherwise, false.
Gets a value indicating whether the installer can upgrade the data source.
true if the installer can upgrade the data source; otherwise, false.
Empty data sources can't be upgraded, just installed.
Gets the version specification for evaluation by DetermineCurrentVersion.
Only first matching specification is taken into account.
The version specifications.
Initializes a new instance of the class.
The SQL helper.
Initializes a new instance of the class.
The SQL helper.
The latest available version.
Installs the latest version into the data source.
If installing or upgrading is not supported.
Determines the current version of the SQL data source,
by attempting to select a certain field from a certain table.
The specifications are retrieved using the VersionSpecs property.
The current version of the SQL data source
Executes a list of semicolon separated statements.
Statements starting with
The statements.
A triple (Field, Table, Version) meaning:
if a SELECT statement of Field FROM Table succeeds,
the database version is at least Version.
This also supports checking for a value in a table.
The SQL statament to execute in order to test for the specified version
An integer identifying the expected row count from the Sql statement
The minimum version number of a database that contains the specified field.
Initializes a new instance of the struct.
The sql statement to execute.
The version.
Initializes a new instance of the struct.
The sql statement to execute.
The expected row count.
The version.
Interface for a utility that helps installing an Umbraco data source.
Gets the current data source version.
The current version.
Gets the latest available version.
The latest version.
Gets a value indicating whether this installer can connect to the data source.
true if the installer can connect; otherwise, false.
Gets a value indicating whether the data source is empty and ready for installation.
true if the data source is empty; otherwise, false.
Gets a value indicating whether the data source has an up to date version.
true if the data source is up to date; otherwise, false.
Gets a value indicating whether the installer can upgrade the data source.
true if the installer can upgrade the data source; otherwise, false.
Empty data sources can't be upgraded, just installed.
Installs the latest version into the data source.
If installing or upgrading is not supported.
Default implementation of the interface.
Initializes a new instance of the class.
The name.
Type of the data.
The size of the field.
The properties.
Gets the name of the field.
The name.
Gets the data type of the field.
The field data type.
Gets the properties.
The properties.
Gets a value indicating the field size.
The size.
Determines whether the field has the specified property.
The property.
true if the field has the property; otherwise, false.
Returns a that represents the current .
A that represents the current .
Default implementation of the interface.
List of table fields.
Initializes a new instance of the class.
The table name.
Gets the name of the table.
The name of the table.
Adds the field to the table.
The field.
Creates a new field.
The name.
The field data type.
A new field.
Creates a new field.
The name.
The field data type.
The properties.
A new field.
Creates a new field.
The name.
The field data type.
The size.
A new field.
Creates a new field.
The name.
The field data type.
The size.
The properties.
A new field.
Finds the field with the specified name.
The name.
The field, or null if a field with the specified name doesn't exist.
Finds the first field satisfiying the matcher.
The matcher.
The first field found, or null if no field matches.
Finds all fields satisfiying the matcher.
The matcher.
A list of all matching fields.
Returns an enumerator that iterates through the collection.
A that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An object that can be used to iterate through the collection.
Returns a that represents the current .
A that represents the current .
Properties for a table field.
No special properties.
The field cannot be null.
The field is an identity field.
Interface for classes that represent a table field.
Gets the name of the field.
The name.
Gets the data type of the field.
The field data type.
Gets a value indicating the field size.
The size.
Gets the properties.
The properties.
Determines whether the field has the specified property.
The property.
true if the field has the property; otherwise, false.
Interface for classes that represent a data source table.
Gets the name of the table.
The name of the table.
Adds the field to the table.
The field.
Creates a new field.
The name.
The field data type.
A new field.
Creates a new field.
The name.
The field data type.
The properties.
A new field.
Creates a new field.
The name.
The field data type.
The size.
A new field.
Creates a new field.
The name.
The field data type.
The size.
The properties.
A new field.
Finds the field with the specified name.
The name.
The field, or null if a field with the specified name doesn't exist.
Finds the first field satisfiying the matcher.
The matcher.
The first field found, or null if no field matches.
Finds all fields satisfiying the matcher.
The matcher.
A list of all matching fields.
Default implementation of the interface.
The type of SQL helper.
Initializes a new instance of the class.
The SQL helper.
Determines whether the table with the specified name exists.
The name.
true if the table exists; otherwise, false.
Gets the table with the specified name.
The name.
The table, or null if no table with that name exists.
Saves or updates the table.
The table to be saved.
Creates the table with the specified name.
The name.
The table.
Interface for a tool that provides access to the tables of a data source.
Determines whether the table with the specified name exists.
The name.
true if the table exists; otherwise, false.
Gets the table with the specified name.
The name.
The table, or null if no table with that name exists.
Creates the table with the specified name.
The name.
The table.
Saves or updates the table.
The table to be saved.
Base class providing access to various Umbraco utilities
that operate on data layer level.
SQL helper the utility uses as data source.
Gets the SQL helper.
The SQL helper.
Initializes a new instance of the class.
The SQL helper.
Creates an installer.
The default installer.
Creates a table utility.
The table utility
Interface for classes providing access to various Umbraco utilities
that operate on data layer level.
Creates an installer.
The installer.
Creates a table utility.
The table utility
Generic class adapter to ISqlParameterContainer for parameters implementing IDataParameter.
SQL parameter data type
The original parameter.
Gets the name of the parameter.
The name of the parameter.
Gets the value of the parameter.
The value of the parameter.
Gets the wrapped parameter.
The wrapped parameter.
Initializes a new instance of the class.
The raw parameter.
Abstract base class for SQL helpers that use parameters implementing IDataParameter.
SQL parameter data type.
The connection string that provides access to the SQL database.
Utility that provides access to complex database actions.
Gets the connection string that provides access to the SQL database.
The connection string that provides access to the SQL database.
Gets the Umbraco utility associated with this SQL helper.
The utilities.
Initializes a new instance of the class.
The connection string.
Initializes a new instance of the class.
The connection string, cannot be null.
The utility, a default utility will be used if null.
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
Performs necessary conversion on the SQL command prior to its execution.
The command text.
The original command text. Inheriting classes can change this behavior.
Performs necessary conversion on the parameters prior to its execution.
The parameters. Expected to be of type IParameterContainer.
The parameters, converted to the raw types of their containers.
Converts the scalar value to the given type.
Desired type of the value.
A scalar returned by ExecuteScalar.
The scalar, converted to type T.
Creates a concatenation fragment for use in an SQL query.
The values that need to be concatenated
The SQL query fragment.
SQL Server uses a+b, MySql uses concat(a,b), Oracle uses a||b...
Escapes a string for use in an SQL query.
The value.
The escaped value.
You should use SQL parameters instead.
Creates a new parameter for use with this specific implementation of ISqlHelper.
Name of the parameter.
Value of the parameter.
A new parameter of the correct type.
Abstract factory pattern
Executes a command that returns a single value.
The type of the value.
The command text.
The parameters.
The return value of the command.
If a data source error occurs.
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
If a data source error occurs.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
If a data source error occurs.
Executes a command that returns an XML value.
The command text.
The parameters.
An XML reader containing the return value.
If a data source error occurs.
Executes a command that returns a single value.
The command text.
The parameters.
The return value of the command.
Executes a command and returns the number of rows affected.
The command text.
The parameters.
The number of rows affected by the command.
Executes a command and returns a records reader containing the results.
The command text.
The parameters.
A data reader containing the results of the command.
Executes a command that returns an XML value.
The command text.
The parameters.
An XML reader containing the return value.
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Interface for a parameter of a data layer instruction.
Gets the name of the parameter.
The name of the parameter.
Gets the value of the parameter.
The value of the parameter.
Class that adapts a generic data reader to an IRecordsReader.
The data reader class
Wrapped data reader.
Gets the internal data reader.
The data reader.
Gets the internal data reader.
The data reader.
Obsolete. You should NOT try to close or dispose the RawDataReader,
but instead close or dispose this RecordsReaderAdapter.
Inheriting classes can call the protected DataReader property.
Initializes a new instance of the class.
The data reader.
Releases unmanaged resources and performs other cleanup operations before the
is reclaimed by garbage collection.
Closes the data reader.
Gets the depth of nesting of the current row.
The depth of nesting of the current row.
Gets a value indicating whether this instance is closed.
true if this instance is closed; otherwise, false.
Advances to the next record.
true if there are more records; otherwise, false.
Gets a value indicating whether this instance has records.
true if this instance has records; otherwise, false.
Gets the value of the specified field.
The field type.
Name of the field.
The value of the specified field
Gets the value of the specified field as a bool.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a byte.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a DateTime.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a decimal.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a double.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a float.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a Guid.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a short.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as an int.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a long.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field as a string.
Name of the field.
The value of the field.
No column with the specified name was found.
Gets the value of the specified field.
Name of the field.
The value of the field.
No column with the specified name was found.
Determines whether the specified field is null.
Name of the field.
true if the specified field is null; otherwise, false.
Determines whether a field with the specified field name exists in the record.
The field can still contain a null value.
Name of the field.
true if the specified field exists; otherwise, false.
Returns the index of the field with the specified name.
The name of the field.
The index of the field.
Returns an enumerator that iterates through the records.
An object that can be used to iterate through records.
Performs application-defined tasks associated with freeing, releasing,
or resetting unmanaged resources.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources;
false to release only unmanaged resources.
Represents an exception that is generated in an Umbraco module.
This should be moved out of the data layer for general use.
The Umbraco component that generated the exception.
Gets the Umbraco component that generated the exception.
The component.
Gets a message that describes the current exception.
The error message that explains the reason for the exception.
Initializes a new instance of the class.
The message.
Initializes a new instance of the class.
The message.
The inner exception.
Enum of all Umbraco components
Unknown component
Business logic component
CMS component
Controls component
Data layer component
Editor controls component
Presentation component
Providers component