TableManager Class

Ensures management of database table and table column.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.TableManager

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23

Syntax

public class TableManager

The TableManager type exposes the following members.

Constructors

	Name	Description
Public method	TableManager	Constructor

Methods

	Name	Description
Public method	AddTableColumn	Add column to specified table.
Public method	AlterProcedure	Alters specified procedure in database
Public method	AlterTableColumn	Rename, retype or allow/not allow NULL values in column
Public method	AlterView	Alters specified view in database
Public method	ColumnExistsInView	Checks if column name is unique in given view.
Public method	CopyTableBySchema	Copies given table as a new one from given table cheme (ensures unique table name for the new table).
Public method	CreateColumnIndexes	Creates the table indexes.
Public method	CreateProcedure	Creates specified procedure in database
Public method	CreateTable(String, String)	Creates specified table in database.
Public method	CreateTable(String, String, Boolean)	Creates specified table in database. Allows specify if identity will be set on primary key column.
Public method	CreateTableByDefinition(String, String)	Creates a new database table based on the provided Schema.
Public method	CreateTableByDefinition(String, String, String)	Creates a new database table based on the provided Schema.
Public method	CreateView	Creates specified view in database
Public method	DeleteDataFromTable	Deletes data from specified table.
Public method	DeleteObject	Removes view or stored procedure from database.
Public method	DropColumnIndexes	Drops the column indexes, returns the DataSet of indexes.
Public method	DropDefaultConstraint	Drops the default constraint.
Public method	DropTable	Drop specified table from database.
Public method	DropTableColumn	Remove column from specified table.
Public method	DropView	Drop specified view from database.
Public method	GetCode	Returns SQL code of specified view or stored procedure.
Public method	GetColumnIndexes	Returns the DataSet of column indexes.
Public method	GetColumnInformation	Returns DataSet with specified table column information retrieved from database information schema. Returns columns ColumnName, DataType, DataSize, DataPrecision, Nullable, DefaultValue
Public method	GetIndexes	Returns DataSet with indexes of the given object. Returns columns IndexName, DropScript, CreateScript
Public method	GetList	Returns list of views or stored procedures.
Public method	GetPKConstraintName	Returns the name of the PK constraint.
Public method	GetPrimaryKeyColumns	Returns list of column names which represent primary keys of the specified database table. Returns empty list if primary keys are not found.
Public method	GetTableDependencies	Gets list of object names which have foreign key constraint dependency.
Public method	GetTablePKName	Returns name of the primary key. If more columns in PK, names are separated by semicolon ";".
Public method	GetTables	Gets the tables in the current database
Public method	GetUniqueTableName	Returns unique table name (automatically generated table name that not yet exist in the database).
Public method Static member	GetValueString	Returns the float string using the database culture.
Public method	GetXmlSchema	Returns XML schema for specified table.
Public method	ChangeDBObjectOwner	Changes database object owner.
Public method Static member	IsGeneratedSystemView	Returns true if the given view is generated view with dynamic code.
Public method	RecreatePKConstraint	Drops the current PK constraint and creates new from given columns.
Public method	RefreshCustomViews	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 method	RefreshDocumentViews	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 method	RefreshView	Refreshes specified view in database.
Public method	RenameTable	Changes name of the table with original name according to the new name.
Public method Static member	SelectFieldNode	Selects single field node with the specified attribute value.
Public method	StoredProcedureExists	Determines whether specified stored procedure exists or not.
Public method	TableExists	Determines whether specified DB table exists or not.
Public method	UpdateTableByDefinition	Updates the structure of given table with new schema. It adds, modifies or removes the columns.
Public method	ViewExists	Determines whether specified DB view exists or not.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	USE_INDEXED_VIEWS	If true, the indexed views are used and generated within the system

Properties

	Name	Description
Public property	ConnectionString	Current connection string for the table management
Public property Static member	DatabaseCulture	Database culture setting from the web.config.
Public property Static member	DatabaseCultureInfo	Database culture info obtained from DatabaseCulture property.
Public property	DatabaseName	Gets database name.
Public property	DatabaseServerName	Gets database server name.
Public property	DatabaseServerVersion	Gets database server version.
Public property	DatabaseSize	Gets database size(including log size) in MB.
Public property	DisableDebug	If true, the table manager disables debug for its queries
Protected property	TableManagerObject	Table manager object
Public property	UpdateSystemFields	Determines whether system fields should be updated when updating table by schema.