Click or drag to resize
TableManager Class
Ensures management of database table and table column.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineTableManager

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class TableManager

The TableManager type exposes the following members.

Constructors
  NameDescription
Public methodTableManager
Constructor
Top
Methods
  NameDescription
Public methodAddTableColumn
Add column to specified table.
Public methodAlterProcedure
Alters specified procedure in database
Public methodAlterTableColumn
Rename, retype or allow/not allow NULL values in column
Public methodAlterView
Alters specified view in database
Public methodColumnExistsInView
Checks if column name is unique in given view.
Public methodCopyTableBySchema
Copies given table as a new one from given table cheme (ensures unique table name for the new table).
Public methodCreateColumnIndexes
Creates the table indexes.
Public methodCreateProcedure
Creates specified procedure in database
Public methodCreateTable(String, String)
Creates specified table in database.
Public methodCreateTable(String, String, Boolean)
Creates specified table in database. Allows specify if identity will be set on primary key column.
Public methodCreateTableByDefinition(String, String)
Creates a new database table based on the provided Schema.
Public methodCreateTableByDefinition(String, String, String)
Creates a new database table based on the provided Schema.
Public methodCreateView
Creates specified view in database
Public methodDeleteDataFromTable
Deletes data from specified table.
Public methodDeleteObject
Removes view or stored procedure from database.
Public methodDropColumnIndexes
Drops the column indexes, returns the DataSet of indexes.
Public methodDropDefaultConstraint
Drops the default constraint.
Public methodDropTable
Drop specified table from database.
Public methodDropTableColumn
Remove column from specified table.
Public methodDropView
Drop specified view from database.
Public methodGetCode
Returns SQL code of specified view or stored procedure.
Public methodGetColumnIndexes
Returns the DataSet of column indexes.
Public methodGetColumnInformation
Returns DataSet with specified table column information retrieved from database information schema. Returns columns ColumnName, DataType, DataSize, DataPrecision, Nullable, DefaultValue
Public methodGetIndexes
Returns DataSet with indexes of the given object. Returns columns IndexName, DropScript, CreateScript
Public methodGetList
Returns list of views or stored procedures.
Public methodGetPKConstraintName
Returns the name of the PK constraint.
Public methodGetPrimaryKeyColumns
Returns list of column names which represent primary keys of the specified database table. Returns empty list if primary keys are not found.
Public methodGetTableDependencies
Gets list of object names which have foreign key constraint dependency.
Public methodGetTablePKName
Returns name of the primary key. If more columns in PK, names are separated by semicolon ";".
Public methodGetTables
Gets the tables in the current database
Public methodGetUniqueTableName
Returns unique table name (automatically generated table name that not yet exist in the database).
Public methodStatic memberGetValueString
Returns the float string using the database culture.
Public methodGetXmlSchema
Returns XML schema for specified table.
Public methodChangeDBObjectOwner
Changes database object owner.
Public methodStatic memberIsGeneratedSystemView
Returns true if the given view is generated view with dynamic code.
Public methodRecreatePKConstraint
Drops the current PK constraint and creates new from given columns.
Public methodRefreshCustomViews
Refreshes all database views which should contain all columns of the specified system table (cms_user, cms_usersettings, com_sku, newsletter_subscriber, community_group). You need to call this method after the column of that system table is added or removed.
Public methodRefreshDocumentViews
Regenerates views [View_CMS_Tree_Joined], [View_CMS_Tree_Joined_Versions], [View_CMS_Tree_Joined_Attachments], [View_CMS_Tree_Joined_Versions_Attachments] and default views for all document types.
Public methodRefreshView
Refreshes specified view in database.
Public methodRenameTable
Changes name of the table with original name according to the new name.
Public methodStatic memberSelectFieldNode
Selects single field node with the specified attribute value.
Public methodStoredProcedureExists
Determines whether specified stored procedure exists or not.
Public methodTableExists
Determines whether specified DB table exists or not.
Public methodUpdateTableByDefinition
Updates the structure of given table with new schema. It adds, modifies or removes the columns.
Public methodViewExists
Determines whether specified DB view exists or not.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Public fieldStatic memberUSE_INDEXED_VIEWS
If true, the indexed views are used and generated within the system
Top
Properties
  NameDescription
Public propertyConnectionString
Current connection string for the table management
Public propertyStatic memberDatabaseCulture
Database culture setting from the web.config.
Public propertyStatic memberDatabaseCultureInfo
Database culture info obtained from DatabaseCulture property.
Public propertyDatabaseName
Gets database name.
Public propertyDatabaseServerName
Gets database server name.
Public propertyDatabaseServerVersion
Gets database server version.
Public propertyDatabaseSize
Gets database size(including log size) in MB.
Public propertyDisableDebug
If true, the table manager disables debug for its queries
Protected propertyTableManagerObject
Table manager object
Public propertyUpdateSystemFields
Determines whether system fields should be updated when updating table by schema.
Top
See Also