Database schema for structure query language (SQL) server

[0001] This application claims priority to U.S. Provisional Application No. 60/249,528, filed Nov. 17, 2000, entitled Database Schema for Structured Query Language (SQL) Server.

[0002] This invention relates to databases and to database management schemas.

[0003] Database management systems (DBMS) are core components of virtually every enterprise (e-business) application. The ability to effectively configure, monitor, and manage a DBMS is critical to the success of enterprise applications.

[0004] Most DBMSs are designed for compatibility with relational databases. A relational database comprises a plurality of tables. Each table has a plurality of data records (rows) and each table includes a definition of the fields (columns) that the records will contain. A relational database includes the specification of relationships between fields of different tables. A DBMS performs common management tasks such as creating databases, adding tables, replication management, data backup, etc.

[0005] The Desktop Management Task Force (DMTF) Common Information Model (CIM) is an approach to the management of systems, software, users, and networks that applies the basic structuring and conceptualization techniques of the object-oriented paradigm. More specifically, the purpose of CIM is to model various computer-related systems-both hardware and software. It is important to recognize that object-oriented modeling is different from object-oriented programming.

[0006] This type of modeling uses schemas to represent systems. A schema is an abstraction of something that exists in the real world. Generally, a schema comprises a collection of classes and associations.

[0007] A class models a set of objects that have similar properties and fulfill similar purposes. In a database management schema, for example, individual classes might define such things as files, users, tables, etc.

[0008] Classes follow a hierarchical structure. Classes can have subclasses, also referred to as specialization classes. The parent class of a subclass is referred to as a superclass or a generalization class. A class that does not have a superclass is referred to as a base class.

[0009] A typical schema might comprise a collection of different schemas, which in this case can also be referred to as subschemas. Such subschemas are often located in various different namespaces. A namespace is simply a way to logically group related data. Within a given namespace, all names are unique. Within the following disclosure, the terms schema and subschema are used interchangeably.

[0010] A subclass inherits properties of its superclass. All properties and methods of a superclass apply to the subclass.

[0011] It is conventional to represent a class by a rectangle containing the name of the class. FIG. 1 shows an example. A class with properties is represented by a rectangle divided into two regions as in FIG. 2, one containing the name of the class and the other a list of properties. Inheritance, or a subclass/superclass relationship, is represented by a line drawn between the subclass and the superclass, with an arrow adjacent to the superclass indicating the superclass. Lines representing inheritance are shown in FIG. 3, indicated by reference numeral 10.

[0012] Classes contain instances that are collections of values that conform to the type established by the class. Instances are identified by keys that are unique within the class. In other words, no two instances in the same class in the same namespace may have the same values for all of their key values. The term object may be used to refer to either an instance or a class.

[0013] An association represents a relationship between two or more objects. More specifically, an association is a mechanism for providing an explicit mapping between classes. Associations can be within a namespace or across namespaces. Associations are conventionally shown as a line between two classes, as indicated by reference number 12 in FIG. 3.

[0014] CIM schemas describe the gamut of managed elements: servers and desktops (operating systems, components, peripherals, and applications, all layers of the network (from Ethernet switches to IP and HTTP connections), and even end-users. Schema properties model the attributes that apply to objects, such as the type of printer or storage medium, RAM and CPU capacity, storage capacity, etc.

[0015] The discussion above gives a general overview of object-oriented modeling and CIM. Please refer to Winston Vumpus, John W. Sweitzer, Patrick Thompson, Andrea R. Westerinin, and Raymond C. Williams; Common Information Model, John Wiley & Sons, Inc., New York (2000) for further information regarding CIM. Also refer to Common Information Model (CIM) Specification, V2.0, Mar. 3, 1998, available from the Distributed Management Taskforce. DMTF has a number of other resources on its Internet web site.

[0016] A database schema described herein is an extension of the CIM core model. It defines classes, properties, methods, and associations for a SQL (structured query language) database. Although a specific embodiment is disclosed herein, it should be recognized that variations of the described embodiment are possible while still remaining within the scope of the appended claims.

[0017] FIGS. 1-3 illustrate CIM drawing conventions.

[0018] FIG. 4 is a block diagram showing components of a typical computer.

[0019] FIGS. 5-14 illustrates a database schema for a SQL database.

[0020] This disclosure addresses a database schema for a SQL (structure query language) database, such as Microsoft's SQL Server database system. Prior to describing the database schema, however, an exemplary computing environment is described to provide a context for implementing the schema.

[0021] Exemplary Computing Environment

[0022] FIG. 4 shows an exemplary computer system 400 that implements the database schema. The computer 400 is representative of many different configurations, including personal computers, server computers, hand-held or laptop devices, multiprocessor systems, micro-processor systems, game consoles, set top boxes, programmable consumer electronics, network PCs, minicomputers, mainframe computers, distributed computing environments that include any of the above systems or devices, and the like. Computer 400 typically includes a variety of computer-readable media. Computer-readable media can be any available media that can be accessed by computer 400 and includes both volatile and nonvolatile media, removable and non-removable media. By way of example, and not limitation, computer-readable media may comprise computer storage media and communication media.

[0023] Communication media typically embodies computer-readable instructions, data structures, program modules or other data in a modulated data signal such as a carrier wave or other transport mechanism and includes any information delivery media. By way of example, communication media includes wired media such as a wired network or direct-wired connection and wireless media such as acoustic, RF, infrared and other wireless media. Combinations of any of the above should also be included within the scope of computer readable media.

[0024] In the FIG. 4 illustration, the computer 400 has a processor unit 402 with one or more processors, volatile memory 404 (e.g., RAM), and non-volatile memory 406 (e.g., ROM, Flash, hard disk, optical, RAID memory, etc.). The computer 400 also includes one or more input devices 408 (e.g., keyboard, mouse, stylus, touch screen, microphone, etc.) and one or more output devices 412 (e.g., display, speakers, printer, etc.) A set of connections 412 may also be provided to facilitate wireless or wire-based communication with other computers, peripherals, and the like.

[0025] The computer 400 runs an operating system 420. The Windows brand of operating systems, available from Microsoft Corporation of Redmond, Wash., is one example of a suitable operating system. The computer 400 is also illustrated as running a database program 422, although this may be executed on a separate computer. The SQL Server brand of database programs, also available from Microsoft Corporation, is an example of a suitable database program.

[0026] For illustration purposes, operating system 420 and database program 422 are shown as discrete blocks stored in the non-volatile memory 406, although it is recognized that such programs and components reside at various times in different storage components of the computer 400 and are executed by the processor 402. Generally, these software components are stored in non-volatile memory 406 and from there, are loaded at least partially into the volatile main memory 404 for execution on the processor 402.

[0027] The Windows 2000 operating system includes a service known as Windows Management Instrumentation (WMI) 430. WMI is an example of a management infrastructure for managing the operating system. It is Microsoft's implementation of the Web-Based Enterprise Management (WBEM) initiative, an industry standard administered by the Distributed Management Task Force (DMTF). WMI provides an object-oriented way of monitoring, configuring and controlling systems, services, and applications on the Windows platform. WMI objects are defined with logical classes derived from the Common Information Model (CIM). WMI provides services such as SQL query language support and programmable event notification.

[0028] To support CIM, WMI maintains a schema definition. The schema definition consists of one or more data structures that are typically stored on some form of non-volatile media. A schema can be installed in one or more namespaces. The schema contains a definition of all classes, their properties, and associations.

[0029] In particular, the computer 400 supports a database schema 432 for use in WMI to represent manageable components of the SQL server database. Such managed objects include tables, files, configuration data, and other logical components. The database schema is located in its own namespace (e.g., rootMicrosoftSQLServer).

[0030] Database Schema

[0031] The remaining discussion pertains to an exemplary management instrumentation schema for an SQL Server database software. The schema is depicted in its entirety in FIGS. 5-14. Throughout the drawings, conventional CIM classes are designated by the prefix CIM. Classes that are defined for the SQL Server database software are designated by the prefix MSSQL. Additionally, another group of classes pertaining to an operating system are also defined. In this example, the operating system is a Windows brand operating system from Microsoft Corporation and the classes are designated by the prefix Win32.

[0032] The schema covers the following five main categories:

[0033] Application System: This category includes SQL Server settings, services, and logs.

[0034] Database Objects: This category includes the components of a database system such as databases, tables, keys, and columns.

[0035] Security: This category includes users, roles, authentication login records, and permission settings for the user and roles.

[0036] Physical Storage: This category includes the physical files and file groups that are used to store the data.

[0037] Bulk Data Operations: This category includes operations such as backup, restore, and bulk copy of data.

[0038] Rather than try to present the entire schema in one drawing, which is impractical, the schema is illustrated over multiple drawings according to the above categories. This results in some classes being replicated in more than one drawing. However, at the risk of some redundancy, each drawing portrays that portion of the schema that covers the category or subcategory.

[0039] Additionally, the schema is generally described below with reference to the corresponding figures. One exemplary implementation of all schema classes, as well as their properties, methods, and associations, is provided following this general description beneath the heading Exemplary Implementation of Database Schema.

[0040] A. Application System

[0041] The schema portions covering the application system of the SQL Server database can be separated into three subcategories: (1) settings, (2) services, and (3) transactions and error logs. The schema portions for these three subcategories are illustrated in FIGS. 5-7.

[0042] FIG. 5 shows a setting portion 500 of the SQL Server schema. Setting portion 500 has a superclass 502 entitled MSSQL_Setting, which is a subclass of a CIM class 504 entitled CIM_Setting. Beneath the MSSQL_Setting class 502 are five subclasses: MSSQL_DatabaseSetting 510 that represents operational settings for a database; MSSQL_ConfigValue 512 that represents configuration values; MSSQL_LanguageSetting 514 that exposes the properties of an installed language record so that error and status information can be presented as localized text; MSSQL_RegistrySetting 516 that represents the installation and run-time parameters stored in the registry; and MSSQL_SQLServerConnectionSetting 518 represents default connection settings used by a WMI provider to connect to SQL DMO (Distributed Management Objects).

[0043] FIG. 5 also illustrates a separate set of CIM classes represented by base class 520 entitled CIM_ManagedSystemElement, which is a base class for the system element hierarchy. Any distinguishable component of a system is a candidate for inclusion in this class. Examples include software components (e.g., files), devices (e.g., disk drives, controllers), and physical components (e.g., chips, cards). Beneath the base class is CIM_LogicalElement class 522, which is the base class for all the components of the system that represent abstract system components (e.g., profiles, processes, system capabilities in the form of logical devices, etc.). A subclass of class 522 is CIM_System class 524, which represents a logical element that aggregates an enumerable set of managed system elements. Beneath CIM_System class 524 is CIM_ApplicationSystem class 526, which represents an application or a software system that supports a particular business function and that can be managed as independent units.

[0044] The schema 500 also defines three extensions to the conventional CIM classes, including MSSQL_DBMSObject class 530, MSSQL_Database class 532, and MSSQL_SQLServer class 534. MSSQL_DBMSObject class 530 is a subclass of CIM_LogicalElement class 522 and represents objects in a database system, such as databases, tables, keys and constraints. MSSQL_Database class 532 represents instances of SQL Server databases and MSSQL_SQLServer class 532 represents instances of the SQL Server.

[0045] FIG. 5 also illustrates associations between the MSSQL_Setting class 502 and MSSQL_Database class 532 and MSSQL_SQLServer class 534. The associations are illustrated as broken lines to distinguish them from the solid inheritance lines. The associations are defined as association-type classes, which include properties and methods like normal classes. Consider an association 540 named MSSQL_DatabaseDatabaseSetting that is defined between the MSSQL DatabaseSetting class 510 and the MSSQL_Database class 532. The MSSQL_DatabaseDatabaseSetting association class 540 associates a SQL Server database to an instance of the MSSQL_DatabaseSetting class 510 that contains the settings for the database.

[0046] Other association classes include the following:

[0047] MSSQL_SQLServerConfigValue class 542 represents an association between a SQL Server installation and the configured value settings for the installation.

[0048] MSSQL_SQLServerLanguageSetting class 544 represents an association between a SQL Server installation and its language settings.

[0049] MSSQL_SQLServerRegistrySetting class 546 represents an association between a SQL Server installation and its registry setting.

[0050] MSSQL_SQLServerSQLServerConnection class 548 represents an association between a SQL Server installation and settings used by the WMI SQL Server administration provider to connect to the SQL Server.

[0051] There is also an association class 550, named MSSQL_SQLServerDatabase, between the MSSQL_SQLServer class 534 and the MSSSQL_Database class 532 that represents an association between a SQL Server installation and a database that is part of the installation. Additionally, FIG. 5 illustrates a CIM_ElementSetting class 552 that associates the CIM_ManagedSystemElement class 520 with the CIM_Setting class 504.

[0052] FIG. 6 shows a services portion 600 of the SQL Server schema. Services portion 600 includes the CIM_Setting class 504, a Win32_BaseService class 604 that represents executable objects installed in a registry database and maintained by the Service Control Manager, a MSSQL_FullTextCatalogService class 606 that represents a single search persistent data store, and a Win32_Service class 608 that represents a service on a 32-bit Windows-brand operating system. There is one association class 610, named MSSQL_FullTextWin32Service, that associates the MSSQL_FullTextCatelogService class 606 with the Win32_Service class 608.

[0053] FIG. 7 shows a portion 700 of the SQL Server schema for the transaction and error logs. Similar to the setting schema portion 500 of FIG. 5, schema portion 700 includes the CIM_LogicalElement class 522, the CIM_System class 524, the CIM_ApplicationSystem class 526, the MSSQL_SQLServer class 534, the MSSQL_DBMSObject class 530, and the MSSQL_Database class 532. New to the schema 700 are a set of subclasses of the CIM_LogicalELement class 522. These subclasses include MSSQL_ErrorLogEntry class 702 that represents entries in a SQL Service error log, MSSQL_ErrorLog 704 that represents the SQL Service error logs, CIM_LogicalFile class 706 that represents a named collection of data located in a file system on a storage extent, and MSSQL_TransactionLog 708 that represents the transaction log of the SQL Server database. A CIM_DataFile class 712 inherits from the CIM_Logical File class 706 to represent a type of logical file that is a named collection of data or executable code.

[0054] The schema 700 defines several association classes, including:

[0055] MSSQL_ErrorLogErrorLogEntry class 720 represents an association between an error log and an entry in the error log.

[0056] MSSQL_SQLServerErrorLog class 722 represents an association between a SQL Server installation and the error log used by the installation.

[0057] MSSQL_ErrorLogDataFile class 724 represents an association between the error log and the operating system file used to store the error log.

[0058] MSSQL_TransactionLogDataFile class 726 represents an association between the transaction log and the operating system file that is used to store the log.

[0059] MSSQL_DatabaseTransactionLog class 728 represents an association between the database and the transaction log for the database.

[0060] MSSQL_SQLServerDatabase class 550, described previously, represents an association between a SQL Server installation and a database that is part of the installation.

[0061] B. Database Objects

[0062] The portions of the schema covering the database objects of the SQL Server database can be divided into four subcategories: (1) objects (e.g., tables, views, stored procedures, etc.), (2) index, (3) constraints, and (4) keys. The schema portions for these four subcategories are illustrated in FIGS. 8-11.

[0063] FIG. 8 shows a portion 800 of the SQL Server schema for the database objects, such as tables, columns, views, databases, stored procedures, and so on. The base class for database objects schema 800 is the MSSQL_DBMSObject class 530. Subclasses of this base class 530 are MSSQL_Column class 802 that represents a column in a table, MSSQL_Trigger class 804 that represents a trigger to be executed when a specified data modification, such as an attempt to delete a row, is attempted on the table, MSSQL_Table class 806 that represents a table in the SQL database, MSSQL_UserDefinedFunction class 808 that represents a user defined function in the SQL database, MSSQL_Database class 532, MSSQL_StoredProcedure class 810 that represents standard as well as extended stored procedures defined in the SQL database, MSSQL_View class 812 that represents view tables in the database, and MSSQL_StoredProcedureParameter class 814 that represents the input and output parameters of a stored procedure.

[0064] The database objects schema 800 defines several association classes, including:

[0065] MSSQL_TableColumn class 820 represents an association between a table and a column contained in the table.

[0066] MSSQL_TableTrigger class 822 represents an association between a table and a trigger defined for the table.

[0067] MSSQL_DatabaseTable class 824 associates a database to all the tables contained in the database.

[0068] MSSQL_DatabaseUserDefinedFunction class 826 represents an association between a database and a user-defined function defined within the database.

[0069] MSSQL_DatabaseView class 828 associates a database to the view contained within the database.

[0070] MSSQL_DatabaseStoredProcedure class 830 represents an association between the database and a stored procedure defined within the database.

[0071] MSSQL_StoredProcedureStoredProcedureParameter class 832 associates a stored procedure to a parameter used in the stored procedure.

[0072] FIG. 9 shows an index portion 900 of the SQL Server schema. Again, the base class is the MSSQL_DBMSObject class 530. Here, two subclasses are defined: MSSQL_Column class 802 and MSSQL_Index class 902 that represents an index for a table. Additionally, the index portion of the schema shows a CIM class 904 named CIM_StatisticalInformation, having a subclass 906 named MSSQL_IndexTableInformation that represents the information regarding the age and structure of the index statistical information.

[0073] Two association classes are also defined:

[0074] MSSQL_IndexColumn class 910 represents an association between an index and a column that participates in the index.

[0075] MSSQL_IndexStatistics class 912 represents an association between an index and the statistical information stored with the index.

[0076] FIG. 10 shows a portion 1000 of the SQL Server schema pertaining to constraints, which are the rules and checks to create constraints on data. The base class is once again the MSSQL_DBMSObject class 530. Beneath this base class 530 are the familiar MSSQ Table class 806, the MSSQL_Column class 802, and MSSQL_Database class 532. Another subclass is MSSQL_Constraint class 1002 that represents constraints defined in the SQL Server database. There are three types of constraints that can be defined: checks, keys, and rules. MSSQL_Default class 1004 represents the attributes of a single SQL Server default. Such defaults provide data to columns and user-defined data types when no other data is available on an INSERT statement execution.

[0077] The remaining subclasses of base class 530 are MSSQL_DRIDefault class 1006 that represents the properties of a SQL Server column DEFAULT constraint and MSSQL Datatype class 1008 that represents all the datatypes defined in a SQL Server installation, including both user-defined datatypes, as well as system-defined datatypes. Beneath the MSSQL_Datatype class 1008 are two subclasses that represent the two types of datatypes: MSSQL_UserDatatype class 1010 and MSSQL_SystemDatatype class 1012.

[0078] The remaining classes illustrated in constraint portion 1000 of the SQL schema are MSSQL_Check class 1014 that represents the attributes of a SQL Server integrity constraint and MSSQL_Rule class 1016 that represents a single data-integrity rule.

[0079] There are a number of association classes defined in this portion of the schema. The association classes include:

[0080] MSSQL_TableCheck class 1020 represents an association between a table and the checks defined for the table.

[0081] MSSQL_UserDatatypeDefault class 1022 represents an association between a user-defined datatype and the rule bound to the column.

[0082] MSSQL_DatabaseDefault class 1024 associates a database to the defaults defined within the database.

[0083] MSSQL_ColumnRule class 1026 represents an association between a column and a rule bound to the column.

[0084] MSSQL_ColumnDRIDefault class 1028 associates a column to a DRI default.

[0085] MSSQL_ColumnDatatype class 1030 associates a column with its data type.

[0086] MSSQL_DatabaseRule class 1032 represents an association between a database and the rules defined within the database.

[0087] MSSQL_UserDatatypeRule class 1034 represents an association between a user defined datatype and the rule bound to the column.

[0088] MSSQL_DatabaseDatatype class 1036 associates a database to the datatypes defined within the database.

[0089] MSSQL_BaseDatatype class 1038 represents an association between a user-defined datatype and the system datatype from which it is derived.

[0090] MSSQL_ColumnDefault class associates a column to the default for the column.

[0091] FIG. 11 shows a portion 1100 of the SQL Server schema pertaining to keys. The base class is once again the MSSQL_DBMSObject class 530. Beneath this base class 530 are previously introduced classes including the MSSQL_Constrain class 1002, the MSSQL_Column class 802, MSSQ_Table class 806, and the MSSQL_Database class 532. Newly presented in this portion of the schema is the MSSQL_Key class 1102 that represents the keys defined for a SQL Server table.

[0092] One subclass of key class 1102 is the MSSQL_CandidateKey class 1104 that represents a candidate key in a SQL Server table. It consists of a set of columns that can uniquely identify a row in a table. Another subclass is MSSQL_ForeignKey class 1106, which represents the foreign keys defined for a SQL Server database table.

[0093] Beneath the candidate key class 1104 are two classes: MSSQL_UniqueKey class 1108 that represents a unique key in a database and MSSQL_PrimaryKey class 1110 that represents a primary key of a table.

[0094] Association classes defined in this portion of the schema include:

[0095] MSSQL_KeyColumn class 1120 represents an association between a key and a column that is part of the key.

[0096] MSSQL_TableKey class 1122 represents an association between a table and a key defined for the table.

[0097] MSSQL_ReferencedTable class 1124 represents an association between a foreign key and the table that contains the primary key referenced by the foreign key.

[0098] MSSQL_DatabaseCandidateKey 1126 represents an association between a database and a candidate key that is present in one of the tables in the database. This association allows an application to perform a single traversal to find the candidate keys in a database.

[0099] MSSQL_ReferencedKey class 1128 represents an association between a foreign key and the candidate key that the foreign key references.

[0100] C. Security

[0101] The schema portions covering the security features of the SQL Server database can be separated into two subcategories: (1) server login records and (2) permissions. The schema portions for these subcategories are illustrated in FIGS. 12-13.

[0102] FIG. 12 shows a security portion 1200 of the SQL Server schema pertaining to server login records. Familiar classes in the security portion 1200 include CIM_Setting class 504, MSSQL_Setting class 502, MSSQL_SQLServer 534, MSSQL_DBMSObject 530, and MSSQL_Database 532. Newly presented classes include MSSQL_IntegratedSecuritySetting class 1202 that represents the integrated security settings when WMI interacts with SQL Server. MSSQL_DBMSUserObject class 1204 represents all objects related to user authentication, including objects such as users, logins, and roles defined for a SQL Server installation. The user, logins, and roles are represented by MSSQL_User class 1206, the MSSQL_Login class 1208, and the MSSQL_Role class 1210, respectively, which are subclasses to the MSSQL_DBMSUserObject class 1204.

[0103] With respect to the MSSQL_Role class 1210, roles are used to establish groups of users with similar security attributes. Permissions can be granted by role, simplifying security planning and administration. Beneath the MSSQL_Role class 1210 are MSSLQ_SQLServerRole class 1212 that represents a SQL Server security role not constrained to operation within a single database and MSSQL_DatabaseRole class 1214 that represents the properties of a SQL Server database role.

[0104] Also illustrated in security portion 1200 of the SQL Server schema is a Win32_Account class 1216 that contains information about user accounts and group accounts known to a Win32 operating system. Descendents of this class are group names recognized by a Windows NT domain as represented by Win32_Group class 1218 and information about a user account on a Win32 system as represented by Win32_UserAccount class 1220.

[0105] Association classes defined in this portion of the schema include the following:

[0106] MSSQL_SQLServerintegratedSecuritySetting class 1230 represents an association between a SQL Server installation and its security settings.

[0107] MSSQL_SQLServerLogin class 1232 represents an association between a SQL server and a login defined within the SQL Server.

[0108] MSSQL_SQLServerServerRole class 1234 represents an association between a SQL Server and server roles defined within the SQL Server.

[0109] MSSQL_SQLServerUser class 1236 represents an association between a SQL Server and a database user. This association allows an application to perform a single traversal to find the database users in a SQL Server and the login to which they are mapped.

[0110] MSSQL_DatabaseLogin class 1238 represents an association between a database and a login that is mapped to a user defined in the database. This association allows an application to perform a single traversal to find the logins used by a database.

[0111] MSSQL_DatabaseOwnerLogin class 1240 represents an association to between a database and the login mapped to the user that owns the database.

[0112] MSSQL_LoginWin32Group class 1242 represents an association between a login and the Win32 user group used for authentication by the login.

[0113] MSSQL_UserLogin class 1244 represents an association between a database user and the login used to authenticate the user.

[0114] MSSQL_MemberLogin class 1246 represents an association between a SQL Server role and a login that is a member of the role.

[0115] MSSQL_LoginDefaultDatabase class 1248 represents an association between a login and the default database for the login.

[0116] MSSQL_LoginWin32UserAccount class 1250 represents an association between a login and the Win32 user account used for authentication by the login.

[0117] Win32_GroupUser class 1252 represents an association between a group and an account that is a member of that group.

[0118] MSSQL_MemberUser class 1256 represents an association between a database role and a user that is a member of the role.

[0119] MSSQL_BMSObjectOwner class 1258 represents an association between a SQL Server database object and the user who owns the object.

[0120] MSSQL_DatabaseUser class 1260 represents an association between a database and a user defined for the database.

[0121] MSSQL_MemberDatabaseRole class 1262 associates two database roles, one being a member of the other.

[0122] MSSQL_DatabaseDatabaseRole class 1264 associates database role to the database within which the role is defined.

[0123] FIG. 13 shows a portion 1300 of the SQL Server schema that relates to permissions of users and roles. All of the classes illustrated in FIG. 13 have been introduced above. New to this schema portion are the association-type class that associates a user or a role with a database object, such as a table, view, and database. In particular, the associations define permissions granted or denied to specific users/roles with regard to specific databases and/or portions of databases.

[0124] The association classes include:

[0125] MSSQL_DatabaseRoleDatabasePermission class 1302 represents the permissions that a database role has for the database in which it is defined.

[0126] MSSQL_UserDatabasePermission class 1304 represents the permissions granted to a user for a database.

[0127] MSSQL_UserStoredProcedurePermission class 1306 represents the permissions granted to a user for a stored procedure.

[0128] MSSQL_DatabaseRoleStoredProcedurePermission class 1308 represents the permissions that a database role has for a stored procedure.

[0129] MSSQL_UserTablePermission class 1310 represents the permissions granted to a user for a table.

[0130] MSSQL_DatabaseRoleTablePermission 1312 represents the permissions that a database role has for a table.

[0131] MSSQL_UserUserDefinedFunctionPermission 1314 represents the permissions granted to a user for a stored procedure.

[0132] MSSQL_DatabaseRoleUserDefinedFunctionPernission 1316 represents the permissions that a database role has for a table.

[0133] MSSQL_UserViewPermission 1318 represents the permissions granted to a user for a view.

[0134] D. Physical Storage

[0135] FIG. 14 shows a portion 1400 of the SQL Server schema that relates physical storage. Many of the classes have been described previously. New to this schema portion are MSSQL_FileGroup class 1402 that exposes the attributes of a the SQL Server filegroup, MSSQL_Extension class 1404 that represents extensions made via associations to a managed system element, and MSSQL_DatabaseFile class 1406 that is an extension to the CIM_DataFile class 712.

[0136] The association classes in portion 1400 include the following:

[0137] MSSQL_Extends class 1410 is an abstract association class that associates a class with another class that extends the former class by defining some new properties and methods.

[0138] MSSQL_DatabaseFileDataFile class 1412 associates a CIM_Datafile class 712 to the MSSQL_DatabaseFile class 1406 class that contains database file specific properties of an operating system file.

[0139] MSSQL_FileGroupDatabaseFile class 1414 associates a database file group to the operating system files that are part of the group.

[0140] MSSQL_IndexFileGroup class 1416 represents an association between an index and a file group that stores the index.

[0141] MSSQL_KeyFileGroup class 1418 represents an association between a key and the file group used to store the key.

[0142] MSSQL_TableFileGroup class 1420 represents an association between a table and the file groups used to store the table.

[0143] MSSQL_TableTextFileGroup class 1422 associates a table with the file group that is used to store the variable length data in the table.

[0144] MSSQL_DatabaseFileGroup class 1424 represents an association between a database and the file group that contains the operating system files that store the data for the database.

[0145] E. Bulk Data Operations

[0146] The operations related to data backup and restore are performed by executing certain methods on the MSSQL_SQLServer class 534, MSSQL_Database class 532, MSSQL_Table class 806, and MSSQL_View class 812. The settings for tehse operations are specified using instances of the following classes:

[0147] MSSQL_RestoreSetting class specifies the behavior of a restore operation for a SQL Server database or log. The class is also used to specify the behavior of the verify operation for a SQL Server backup.

[0148] MSSQL_BackupSetting class specifies the settings for a backup operation.

[0149] MSSQL_TransferSetting class represents the settings used to control the data elements moved from one SQL database to another.

[0150] MSSQL_BulkCopySetting class represents the settings for importing or exporting data from a table or a view.

[0151] Exemplary Implementation of Database Schema

[0152] The following provides one exemplary implementation of all schema classes introduced above, as well as their properties, methods, and associations. The various classes are grouped together as CIM classes, MSSQL classes, and Win32 classes.

[0153] A. CIM Classes

[0154] CIM_ApplicationSystem

[0155] The CIM_ApplicationSystem class is used to represent an application or a software system that supports a particular business function and that can be managed as independent units. Such a system can be decomposed into its functional components using the CIM_SoftwareFeature class. The software features for a particular application or software system are located using the CIM_ApplicationSystemSoftwareFeature association.

[0156] Properties

[0157] string Caption

[0158] Access Type: Read-only

[0159] The Caption property is a short textual description (one-line string) of the object.

[0160] Maximum Length: 64

[0161] string CreationClassName

[0162] Access Type: Read-only

[0163] The CreationClassName property indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0164] string Description

[0165] Access Type: Read-only

[0166] The Description property provides a textual description of the object.

[0167] datetime InstallDate

[0168] Access Type: Read-only

[0169] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0170] string Name

[0171] Access Type: Read-only

[0172] The inherited Name property serves as key of a CIM_System instance in an enterprise environment.

[0173] string NameFormat

[0174] Access Type: Read-only

[0175] The CIM_System object and its derivatives are top level objects of CIM. They provide the scope for numerous components. Having unique system keys is required. A heuristic can be defined in individual system subclasses to attempt to always generate the same system name key. The NameFormat property identifies how the system name was generated, using the subclass' heuristic.

[0176] string PrimaryOwnerContact

[0177] Access Type: Read-only

[0178] A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, . . . ).

[0179] string PrimaryOwnerName

[0180] Access Type: Read-only

[0181] The name of the primary system owner.

[0182] string Roles

[0183] Access Type: Read/Write

[0184] A collection of strings that specify the roles this system plays in the IT-environment.

[0185] string Status

[0186] Access Type: Read-only

[0187] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0188] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0189] Maximum Length: 10

[0190] CIM_LogicalFile

[0191] Abstract Class

[0192] The CIM_LogicalFile class represents a named collection of data (this can be executable code) located in a file system on a storage extent.

[0193] Properties

[0194] uint32 AccessMask

[0195] Access Type: Read-only

[0196] The AccessMask property is a bit array representing the access rights to the given file or directory held by the user or group on whose behalf the instance is returned. This property is only supported under Windows NT and Windows 2000. On Windows 98 and on Windows NT/2000 FAT volumes, FULL_ACCESS is returned, indicating no security has been set on the object.

Bit Position	Description
0	FILE_READ_DATA (file) or FILE_LIST_DIRECTORY
	(directory)
1	FILE_WRITE_DATA (file) or FILE_ADD_FILE
	(directory)
2	FILE_APPEND_DATA (file) or
	FILE_ADD_SUBDIRECTORY (directory)
3	FILE_READ_EA
4	FILE_WRITE_EA
5	FILE_EXECUTE (file) or FILE_TRAVERSE (directory)
6	FILE_DELETE_CHILD (directory)
7	FILE_READ_ATTRIBUTES
8	FILE_WRITE_ATTRIBUTES
16	DELETE
17	READ_CONTROL
18	WRITE_DAC
19	WRITE_OWNER
20	SYNCHRONIZE

[0197] boolean Archive

[0198] Access Type: Read-only

[0199] The Archive property is a boolean value indicating that the file should be archived.

[0200] string Caption

[0201] Access Type: Read-only

[0202] The Caption property is a short textual description (one-line string) of the object.

[0203] Maximum Length: 64

[0204] boolean Compressed

[0205] Access Type: Read-only

[0206] The Compressed property is a boolean value indicating that the file is compressed.

[0207] string CompressionMethod

[0208] Access Type: Read-only

[0209] The CompressionMethod property is a free form string indicating the algorithm or tool used to compress the logical file. If it is not possible (or not desired) to describe the compression scheme (perhaps because it is not known), use the following words: Unknown to represent that it is not known whether the logical file is compressed or not, Compressed to represent that the file is compressed but either its compression scheme is not known or not disclosed, and Not Compressed to represent that the logical file is not compressed.

[0210] string CreationClassName

[0211] Access Type: Read-only

[0212] The CreationClassName property is a string indicating the name of this class.

[0213] datetime CreationDate

[0214] Access Type: Read-only

[0215] The CreationDate property is a datetime value indicating the file's creation date.

[0216] string CSCreationClassName

[0217] Access Type: Read-only

[0218] The CSCreationClassName property is a string indicating the class of the computer system.

[0219] string CSName

[0220] Access Type: Read-only

[0221] The CSName property is a string indicating the name of the computer system.

[0222] string Description

[0223] Access Type: Read-only

[0224] The Description property provides a textual description of the object.

[0225] string Drive

[0226] Access Type: Read-only

[0227] The Drive property is a string representing the drive letter (including colon) of the file. Example: c:

[0228] string EightDotThreeFileName

[0229] Access Type: Read-only

[0230] The EightDotThreeFileName property is a string representing the DOS-compatible file name for this file. Example: c:progra1

[0231] boolean Encrypted

[0232] Access Type: Read-only

[0233] The Encrypted property is a boolean value indicating that the file is encrypted.

[0234] string EncryptionMethod

[0235] Access Type: Read-only

[0236] The EncryptionMethod property is a free form string indicating the algorithm or tool used to encrypt the logical file. If it is not possible (or not desired) to describe the encryption scheme (perhaps for security reasons), use the following words: Unknown to represent that it is not known whether the logical file is encrypted or not, Encrypted to represent that the file is encrypted but either its encryption scheme is not known or not disclosed, and Not Encrypted to represent that the logical file is not encrypted.

[0237] string Extension

[0238] Access Type: Read-only

[0239] The Extension property is a string representing the file's extension (without the dot). Example: txt, mof, mdb.

[0240] string FileName

[0241] Access Type: Read-only

[0242] The FileName property is a string representing the filename (without extension) of the file. Example: autoexec

[0243] uint64 FileSize

[0244] Access Type: Read-only

[0245] The FileSize property represents the size of the file (in bytes).

[0246] Units: Bytes

[0247] string FileType

[0248] Access Type: Read-only

[0249] The FileType property is a string descriptor representing the file type (indicated by the Extension property).

[0250] string FSCreationClassName

[0251] Access Type: Read-only

[0252] The FSCreationClassName property is a string indicating the class of the file system.

[0253] string FSName

[0254] Access Type: Read-only

[0255] The FSName property is string indicating the name of the file system.

[0256] boolean Hidden

[0257] Access Type: Read-only

[0258] The Hidden property is a boolean value indicating if the file is hidden.

[0259] datetime InstallDate

[0260] Access Type: Read-only

[0261] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0262] uint64 InUseCount

[0263] Access Type: Read-only

[0264] The InUseCount property is an integer indicating the number of file opens that are currently active against the file.

[0265] datetime LastAccessed

[0266] Access Type: Read-only

[0267] The LastAccessed property is a datetime value indicating the time the file was last accessed.

[0268] datetime LastModified

[0269] Access Type: Read-only

[0270] The LastModified property is a datetime value indicating the time the file was last modified.

[0271] key string Name

[0272] Access Type: Read-only

[0273] The Name property is a string representing the inherited name that serves as a key of a logical file instance within a file system. Full path names should be provided. Example: c:winntsystemwin.ini

[0274] string Path

[0275] Access Type: Read-only

[0276] The Path property is a string representing the path of the file. This includes leading and trailing backslashes. Example:windowssystem

[0277] boolean Readable

[0278] Access Type: Read-only

[0279] The Readable property is a boolean value indicating if the file can be read.

[0280] string Status

[0281] Access Type: Read-only

[0282] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0283] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0284] Maximum Length: 10

[0285] boolean System

[0286] Access Type: Read-only

[0287] The system property is a boolean value indicating if the file is a system file.

[0288] boolean Writeable

[0289] Access Type: Read-only

[0290] The Writeable property is a boolean value indicating if the file can be written.

[0291] Methods

[0292] The CIM_LogicalFile class supports the following methods:

Method Name	Description
ChangeSecurityPermissions	The
	ChangeSecurityPermissions
	method changes the
	security permissions for
	the logical file.
ChangeSecurityPermissionsEx	The
	ChangeSecurityPermissionsEx
	method changes the security
	permissions for the logical
	file. The
	ChangeSecurityPermissionsEx
	method is an extended
	version of the
	ChangeSecurityPermissions
	method.
Copy	The Copy method copies the
	logical file or directory.
CopyEx	The CopyEx method copies the
	logical file or directory.
	CopyEx is an extended
	version of the Copy method.
Compress	The Compress method compresses
	the logical file (or directory).
CompressEx	The CompressEx method
	compresses the logical file
	(or directory). CompressEx
	is an extended version of
	the Compress method.
Delete	The Delete method will
	delete the logical file
	(or directory).
DeleteEx	The DeleteEx method will
	delete the logical file
	(or directory) specified
	in the object path. DeleteEx
	is an extended version of
	the Delete method.
GetEffectivePermission	The GetEffectivePermission
	method determines whether
	the caller has permissions
	for the file (or directory).
Rename	The Rename method renames
	the logical file
	(or directory).
TakeOwnerShip	The TakeOwnerShip method
	obtains ownership of the
	logical file.
TakeOwnerShipEx	The TakeOwnerShipEx
	method obtains ownership of
	the logical file.
	TakeOwnerShipEx is an
	extended version of the
	TakeOwnerShip method.
Uncompress	The Uncompress method
	uncompresses the logical
	file (or directory).
UncompressEx	The UncompressEx method
	uncompresses the logical
	file (or directory).
	UncompressEx is an
	extended version of the
	Uncompress method.

[0293] CIM_LogicalIdentity

[0294] Abstract Class

[0295] Association Class

[0296] CIM_LogicalIdentity is an abstract and generic association, indicating that two CIM_LogicalElements represent different aspects of the same underlying entity. This relationship conveys what could be defined with multiple inheritance. It is restricted to the logical aspects of a CIM_ManagedSystemElement. In most scenarios, the Identity relationship is determined by the equivalence of Keys or some other identifying properties of the related Elements. The association should only be used in well-understood scenarios. This is why the association is abstractallowing more concrete definition and clarification in subclasses. One of the scenarios where this relationship is reasonable is to represent that a Device is both a bus entity and a functional entity. For example, a Device could be both a USB (bus) and a Keyboard (functional) entity.

[0297] References

[0298] key CIM LogicalElement SystemElement

[0299] Access Type: Read-only

[0300] SystemElement represents one aspect of the LogicalElement.

[0301] key CIM_LogicalElement SameElement

[0302] Access Type: Read-only

[0303] SameElement represents an alternate aspect of the System entity.

[0304] CIM_ManagedSystemElement

[0305] Abstract Class

[0306] The CIM_ManagedSystemElement class is the base class for the system element hierarchy. Membership criteria: Any distinguishable component of a system is a candidate for inclusion in this class. Examples: software components, such as files; and devices, such as disk drives and controllers, and physical components such as chips and cards.

[0307] Properties

[0308] string Caption

[0309] Access Type: Read-only

[0310] The Caption property is a short textual description (one-line string) of the object.

[0311] Maximum Length: 64

[0312] string Description

[0313] Access Type: Read-only

[0314] The Description property provides a textual description of the object.

[0315] datetime InstallDate

[0316] Access Type: Read-only

[0317] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0318] string Name

[0319] Access Type: Read-only

[0320] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[0321] string Status

[0322] Access Type: Read-only

[0323] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0324] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0325] Maximum Length: 10

[0326] Associations

[0327] CIM_ManagedSystemElement is associated to

[0328] CIM_ManagedSystemElement as the GroupComponent property of the CIM_Component association.

[0329] CIM_ManagedSystemElement is associated to CIM_ManagedSystemElement as the PartComponent property of the CIM_Component association.

[0330] CIM_ManagedSystemElement is associated to CIM_Setting as the Element property of the CIM_ElementSetting association.

[0331] CIM_ManagedSystemElement is associated to CIM_ManagedSystemElement as the Antecedent property of the CIM_Dependency association.

[0332] CIM_ManagedSystemElement is associated to CIM_ManagedSystemElement as the Dependent property of the CIM_Dependency association.

[0333] CIM_ManagedSystemElement is associated to CIM StatisticalInformation as the Element property of the CIM_Statistics association.

[0334] CIM_ManagedSystemElement is associated to MSSQL_Extension as the ExtendedElement property of the MSSQL_Extends association.

[0335] CIM_ManagedSystemElement is associated to CIM_ManagedSystemElement as the Containee property of the MSSQL_Containment association.

[0336] CIM_ManagedSystemElement is associated to CIM_ManagedSystemElement as the Container property of the MSSQL_Containment association.

[0337] CIM_Process: CIM_LogicalElement

[0338] Abstract Class

[0339] The CIM_Process class is derived from CIM_LogicalElement. It is intended to represent a program in execution, running under an operating system. Processes are also known as tasks.

[0340] Properties

[0341] string Caption

[0342] Access Type: Read-only

[0343] The Caption property is a short textual description (one-line string) of the object.

[0344] Maximum Length: 64

[0345] string CreationClassName

[0346] Access Type: Read-only

[0347] The inherited CreationClassName property indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0348] datetime CreationDate

[0349] Access Type: Read-only

[0350] Time that the process began executing

[0351] string CSCreationClassName

[0352] Access Type: Read-only

[0353] The inherited CSCreationClassName property is a string indicating the class of the computer system.

[0354] string CSName

[0355] Access Type: Read-only

[0356] The inherited CSName property is a string indicating the name of the computer system.

[0357] string Description

[0358] Access Type: Read-only

[0359] The Description property provides a textual description of the object.

[0360] uint16 ExecutionState

[0361] Access Type: Read-only

[0362] Indicates the current operating condition of the process.

Value	Description
0	Unknown
1	Other
2	Ready
3	Running
4	Blocked
5	Suspended Blocked
6	Suspended Ready

[0363] string Handle

[0364] Access Type: Read-only

[0365] A string used to identify the process. A process ID is a process handle.

[0366] datetime InstallDate

[0367] Access Type: Read-only

[0368] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0369] uint64 KernelModeTime

[0370] Access Type: Read-only

[0371] Time in kernel mode, in milliseconds. If this information is not available, a value of 0 should be used.

[0372] Units: Milliseconds (ms)

[0373] string Name

[0374] Access Type: Read-only

[0375] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[0376] string OSCreationClassName

[0377] Access Type: Read-only

[0378] The inherited OSCreationClassName property indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0379] string OSName

[0380] Access Type: Read-only

[0381] The inherited OSName property serves as key of an operating system instance within a computer system.

[0382] uint32 Priority

[0383] Access Type: Read-only

[0384] Priority indicates the urgency or importance of execution of a process. If a priority is not defined for a process, a value of 0 should be used.

[0385] string Status

[0386] Access Type: Read-only

[0387] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0388] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0389] Maximum Length: 10

[0390] datetime TerminationDate

[0391] Access Type: Read-only

[0392] Time that the process was stopped or terminated.

[0393] uint64 UserModeTime

[0394] Access Type: Read-only

[0395] Time in user mode, in milliseconds. If this information is not available, a value of 0 should be used.

[0396] Units: Milliseconds (ms)

[0397] uint64 WorkingSetSize

[0398] Access Type: Read-only

[0399] The amount of memory in bytes that a process needs to execute efficiently, for an operating system that uses page-based memory management. If an insufficient amount of memory is available (<working set size), thrashing will occur. If this information is not known, NULL or 0 should be entered. If this data is provided, it could be monitored to understand a process' changing memory requirements as execution proceeds.

[0400] Units: Bytes

[0401] CIM_Service: CIM_LogicalElement

[0402] Abstract Class

[0403] The CIM_Service class represents a logical element that contains the information necessary to represent and manage the functionality provided by a device and/or software feature. A service is a general-purpose object to configure and manage the implementation of functionality. It is not the functionality itself.

[0404] Properties

[0405] string Caption

[0406] Access Type: Read-only

[0407] The Caption property is a short textual description (one-line string) of the object.

[0408] Maximum Length: 64

[0409] string CreationClassName

[0410] Access Type: Read-only

[0411] CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0412] string Description

[0413] Access Type: Read-only

[0414] The Description property provides a textual description of the object.

[0415] datetime InstallDate

[0416] Access Type: Read-only

[0417] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0418] key string Name

[0419] Access Type: Read-only

[0420] The Name property uniquely identifies the service and provides an indication of the functionality that is managed. This functionality is described in more detail in the object's Description property.

[0421] boolean Started

[0422] Access Type: Read-only

[0423] Started is a boolean indicating whether the service has been started (TRUE), or stopped (FALSE).

[0424] string StartMode

[0425] Access Type: Read-only

[0426] StartMode is a string value indicating whether the service is automatically started by a operating system, or only started upon request.

[0427] Values are: Automatic, Manual

[0428] string Status

[0429] Access Type: Read-only

[0430] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0431] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0432] Maximum Length: 10

[0433] string SystemCreationClassName

[0434] Access Type: Read-only

[0435] The type name of the system that hosts this service

[0436] string SystemName

[0437] Access Type: Read-only

[0438] The name of the system that hosts this service

[0439] Methods

[0440] The CIM_Service class supports the following methods:

	Method Name	Description
	StartService	The StartService method places the service
		in the started state.
	StopService	The StopService method places the service
		in the stopped state.

[0441] CIM_Setting

[0442] Abstract Class

[0443] The CIM_Setting class represents configuration-related and operational parameters for one or more CIM_ManagedSystemElement(s). A CIM_ManagedSystemElement may have multiple Setting objects associated with it. The current operational values for an Element's parameters are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values present in the CIM_Setting object. For example, a modem may have a CIM_Setting baud rate of 56 Kb/sec but be operating at 19.2 Kb/sec.

[0444] Properties

[0445] string Caption

[0446] Access Type: Read-only

[0447] A short textual description (one-line string) of the CIM_Setting object.

[0448] Maximum Length: 64

[0449] string Description

[0450] Access Type: Read-only

[0451] A textual description of the CIM_Setting object.

[0452] tring SettingID

[0453] Access Type: Read-only

[0454] The identifier by which the CIM_Setting object is known.

[0455] Maximum Length: 256

[0456] Associations

[0457] CIM_Setting is associated to CIM_ManagedSystemElement as the Setting property of the CIM_ElementSetting association.

[0458] CIM_StatisticalInformation

[0459] Abstract Class

[0460] CIM_StatisticalInformation is a root class for any arbitrary collection of statistical data and/or metrics applicable to one or more managed system elements.

[0461] Properties

[0462] string Caption

[0463] Access Type: Read-only

[0464] A short textual description (one-line string) for the statistic or metric.

[0465] Maximum Length: 64

[0466] string Description

[0467] Access Type: Read-only

[0468] A textual description of the statistic or metric.

[0469] string Name

[0470] Access Type: Read-only

[0471] The Name property defines the label by which the statistic or metric is known. When subclassed, the property can be overridden to be a Key property.

[0472] Maximum Length: 256

[0473] Associations

[0474] CIM_StatisticalInformation is associated to CIM_ManagedSystemElement as the Stats property of the CIM_Statistics association.

[0475] CIM_Statistics

[0476] Abstract Class

[0477] Association Class

[0478] CIM_Statistics is an association that relates managed system elements to the statistical group(s) that apply to them.

[0479] References

[0480] CIM_ManagedSystemElement Element

[0481] Access Type: Read-only

[0482] The CIM_ManagedSystemElement for which statistical or metric data is defined.

[0483] CIM_StatisticalInformation Stats

[0484] Access Type: Read-only

[0485] The statistical information/object.

[0486] CIM_StorageExtent: CIM_LogicalDevice

[0487] Abstract Class

[0488] The CIM_StorageExtent class describes the capabilities and management of the various media that exist to store data and allow data retrieval.

[0489] Properties

[0490] uint16 Access

[0491] Access Type: Read-only

[0492] The Access property describes whether the media is readable, writeable, or both. Unknown can also be returned.

Value	Description
0	Unknown
1	Readable
2	Writeable
3	Read/Write Supported

[0493] uint16 Availability

[0494] Access Type: Read-only

[0495] The availability and status of the device. For example, the Availability property indicates that the device is running and has full power, or is in a warning, test, degraded or power save state. Regarding the power saving states, these are defined as follows: Power SaveUnknown indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; Power SaveLow Power Mode indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; Power SaveStandby describes that the device is not functioning but could be brought to full power quickly; and Power SaveWarning indicates that the device is in a warning state, though also in a power save mode.

Value	Description
1	Other
2	Unknown
3	Running/Full Power
4	Warning
5	In Test
6	Not Applicable
7	Power Off
8	Off Line
9	Off Duty
10	Degraded
11	Not Installed
12	Install Error
13	Power Save - Unknown
14	Power Save - Low Power Mode
15	Power Save - Standby
16	Power Cycle
17	Power Save - Warning

[0496] uint64 BlockSize

[0497] Access Type: Read-only

[0498] Size in bytes of the blocks that form this storage extent. If unknown or if a block concept is not valid (for example, for aggregate extents, memory or logical disks), enter a 1.

[0499] Units: Bytes

[0500] string Caption

[0501] Access Type: Read-only

[0502] The Caption property is a short textual description (one-line string) of the object.

[0503] Maximum Length: 64

[0504] uint32 ConfigManagerErrorCode

[0505] Access Type: Read-only

[0506] Indicates the Win32 Configuration Manager error code.

Value	Description
0	This device is working properly.
1	This device is not configured correctly.
2	Windows cannot load the driver for this device.
3	The driver for this device might be corrupted,
	or your system may be running low on memory or
	other resources.
4	This device is not working properly. One of
	its drivers or your registry might be corrupted.
5	The driver for this device needs a resource
	that Windows cannot manage.
6	The boot configuration for this device conflicts
	with other devices.
7	Cannot filter.
8	The driver loader for the device is missing.
9	This device is not working properly because the
	controlling firmware is reporting the resources
	for the device incorrectly.
10	This device cannot start.
11	This device failed.
12	This device cannot find enough free resources
	that it can use.
13	This device cannot find enough free resources
	that it can use.
14	Windows cannot verify this device's resources.
15	This device cannot work properly until you
	restart your computer.
16	This device is not working properly because there
	is probably a re-enumeration problem.
17	Windows cannot identity all the resources this
	device uses.
18	This device is asking for an unknown resource
	type.
19	Reinstall the drivers for this device.
20	Your registry might be corrupted.
21	System failure: Try changing the driver for
	this device. If that does not work, see your
	hardware documentation. Windows is removing this
	device.
22	This device is disabled.
23	System failure: Try changing the driver for
	this device. If that doesn't work, see your
	hardware documentation.
24	This device is not present, is not working
	properly, or does not have all its drivers
	installed.
25	Windows is still setting up this device.
26	Windows is still setting up this device.
27	This device does not have valid log configuration.
28	The drivers for this device are not installed.
29	This device is disabled because the firmware of
	the device did not give it the required resources.
30	This device is using an Interrupt Request (IRQ)
	resource that another device is using.
31	This device is not working properly because
	Windows cannot load the drivers required for this
	device.

[0507] boolean ConfigManagerUserConfig

[0508] Access Type: Read-only

[0509] Indicates whether the device is using a user-defined configuration.

[0510] string CreationClassName

[0511] Access Type: Read-only

[0512] CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0513] string Description

[0514] Access Type: Read-only

[0515] The Description property provides a textual description of the object.

[0516] string DeviceID

[0517] Access Type: Read-only

[0518] DeviceID is an address or other identifying information to uniquely name the logical device.

[0519] boolean ErrorCleared

[0520] Access Type: Read-only

[0521] ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.

[0522] string ErrorDescription

[0523] Access Type: Read-only

[0524] ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.

[0525] string ErrorMethodology

[0526] Access Type: Read-only

[0527] ErrorMethodology is a free-form string describing the type of error detection and correction supported by this storage extent.

[0528] datetime InstallDate

[0529] Access Type: Read-only

[0530] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0531] uint32 LastErrorCode

[0532] Access Type: Read-only

[0533] LastErrorCode captures the last error code reported by the logical device.

[0534] key string Name

[0535] Access Type: Read-only

[0536] The Name property defines the label by which the object is known.

[0537] uint64 NumberOfBIocks

[0538] Total number of consecutive blocks, each block the size of the value contained in the BlockSize property, which form this storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1, this property is the total size of the storage extent.

[0539] string PNPDeviceID

[0540] Access Type: Read-only

[0541] Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP03

[0542] uint16 PowerManagementCapabilities

[0543] Access Type: Read-only

[0544] Indicates the specific power-related capabilities of the logical device. The array values, 0Unknown, 1Not Supported and 2Disabled are self-explanatory. The value, 3Enabled indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. Power Saving Modes Entered Automatically (4) describes that a device can change its power state based on usage or other criteria. Power State Settable (5) indicates that the SetPowerState method is supported. Power Cycling Supported (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (Power Cycle). Timed Power On Supported (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (Power Cycle) and the Time parameter set to a specific date and time, or interval, for power-on.

[0545] Values are: Unknown, Not Supported, Disabled, Enabled, Power Saving Modes Entered Automatically, Power State Settable, Power Cycling Supported, Timed Power On Supported

[0546] boolean PowerManagementSupported

[0547] Access Type: Read-only

[0548] Indicates that the device can be power managedi.e. can be put into suspend mode, etc. This boolean does not indicate that power management features are currently enabled, only that the logical device is capable of power management.

[0549] string Purpose

[0550] Access Type: Read-only

[0551] A free form string describing the media and/or its use.

[0552] string Status

[0553] Access Type: Read-only

[0554] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0555] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0556] Maximum Length: 10

[0557] uint16 StatusInfo

[0558] Access Type: Read-only

[0559] StatusInfo is a string indicating whether the logical device is in an enabled (value3), disabled (value4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 (Not Applicable), should be used.

Value	Description
1	Other
2	Unknown
3	Enabled
4	Disabled
5	Not Applicable

[0560] string SystemCreationClassName

[0561] Access Type: Read-only

[0562] The scoping system's CreationClassName.

[0563] string SystemName

[0564] Access Type: Read-only

[0565] The scoping system's Name.

[0566] Methods

[0567] The CIM_StorageExtent class supports the following methods:

Method Name	Description
Reset	Requests a reset of the logical device.
SetPowerState	SetPowerState defines the desired power state for
	a logical device and when a device should be put
	into that state.

[0568] CIM_System: CIM_LogicalElement

[0569] Abstract Class

[0570] The CIM_System class represents a logical element that aggregates an enumerable set of managed system elements. The aggregation operates as a functional whole. Within any particular subclass of CIM_System, there is a well-defined list of CIM_ManagedSystemElement classes whose instances must be aggregated.

[0571] Properties

[0572] string Caption

[0573] Access Type: Read-only

[0574] The Caption property is a short textual description (one-line string) of the object.

[0575] Maximum Length: 64

[0576] string CreationClassName

[0577] Access Type: Read-only

[0578] The CreationClassName property indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0579] string Description

[0580] Access Type: Read-only

[0581] The Description property provides a textual description of the object.

[0582] datetime InstallDate

[0583] Access Type: Read-only

[0584] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0585] string Name

[0586] Access Type: Read-only

[0587] The inherited Name property serves as key of a CIM_System instance in an enterprise environment.

[0588] string NameFormat

[0589] Access Type: Read-only

[0590] The CIM_System object and its derivatives are top level objects of CIM. They provide the scope for numerous components. Having unique system keys is required. A heuristic can be defined in individual system subclasses to attempt to always generate the same system name key. The NameFormat property identifies how the system name was generated, using the subclass' heuristic.

[0591] string PrimaryOwnerContact

[0592] Access Type: Read-only

[0593] A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, . . . ).

[0594] string PrimaryOwnerName

[0595] Access Type: Read-only

[0596] The name of the primary system owner.

[0597] string Roles

[0598] Access Type: Read/Write

[0599] A collection of strings that specify the roles this system plays in the IT-environment.

[0600] string Status

[0601] Access Type: Read-only

[0602] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0603] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0604] Maximum Length: 10

[0605] B. MSSQL Classes

[0606] MSSQL_BackupDevice: CIM_StorageExtent

[0607] The MSSQL_BackupDevice class represents backup devices known to the SQL Server installation.

[0608] Properties

[0609] uint16 Access

[0610] Access Type: Read-only

[0611] The Access property describes whether the media is readable, writeable, or both. Unknown can also be returned.

Value	Description
0	Unknown
1	Readable
2	Writeable
3	Read/Write Supported

[0612] uint16 Availability

[0613] Access Type: Read-only

[0614] The availability and status of the device. For example, the Availability property indicates that the device is running and has full power, or is in a warning, test, degraded or power save state. Regarding the power saving states, these are defined as follows: Power SaveUnknown indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; Power SaveLow Power Mode indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; Power SaveStandby describes that the device is not functioning but could be brought to full power quickly; and Power SaveWarning indicates that the device is in a warning state, though also in a power save mode.

Value	Description
1	Other
2	Unknown
3	Running/Full Power
4	Warning
5	In Test
6	Not Applicable
7	Power Off
8	Off Line
9	Off Duty
10	Degraded
11	Not Installed
12	Install Error
13	Power Save - Unknown
14	Power Save - Low Power Mode
15	Power Save - Standby
16	Power Cycle
17	Power Save - Warning

[0615] uint64 BlockSize

[0616] Access Type: Read-only

[0617] Size in bytes of the blocks that form this storage extent. If unknown or if a block concept is not valid (for example, for aggregate extents, memory or logical disks), enter a 1.

[0618] Units: Bytes

[0619] string Caption

[0620] Access Type: Read-only

[0621] The Caption property is a short textual description (one-line string) of the object. Maximum Length: 64

[0622] uint32 ConfigManagerErrorCode

[0623] Access Type: Read-only

[0624] Indicates the Win32 Configuration Manager error code.

Value	Description
0	This device is working properly.
1	This device is not configured correctly.
2	Windows cannot load the driver for this device.
3	The driver for this device might be corrupted, or your system
	may be running low on memory or other resources.
4	This device is not working properly. One of its drivers or
	your registry might be corrupted.
5	The driver for this device needs a resource that Windows
	cannot manage.
6	The boot configuration for this device conflicts with other
	devices.
7	Cannot filter.
8	The driver loader for the device is missing.
9	This device is not working properly because the controlling
	firmware is reporting the resources for the device incorrectly.
10	This device cannot start.
11	This device failed.
12	This device cannot find enough free resources that it can use.
13	This device cannot find enough free resources that it can use.
14	Windows cannot verify this device's resources.
15	This device cannot work properly until you restart your
	computer.
16	This device is not working properly because there is probably
	a re-enumeration problem.
17	Windows cannot identify all the resources this device uses.
18	This device is asking for an unknown resource type.
19	Reinstall the drivers for this device.
20	Your registry might be corrupted.
21	System failure: Try changing the driver for this device. If that
	does not work, see your hardware documentation. Windows
	is removing this device.
22	This device is disabled.
23	System failure: Try changing the driver for this device. If that
	doesn't work, see your hardware documentation.
24	This device is not present, is not working properly, or does
	not have all its drivers installed.
25	Windows is still setting up this device.
26	Windows is still setting up this device.
27	This device does not have valid log configuration.
28	The drivers for this device are not installed.
29	This device is disabled because the firmware of the device
	did not give it the required resources.
30	This device is using an Interrupt Request (IRQ) resource that
	another device is using.
31	This device is not working properly because Windows
	cannot load the drivers required for this device.

[0625] boolean ConfigManagerUserConfig

[0626] Access Type: Read-only

[0627] Indicates whether the device is using a user-defined configuration.

[0628] string CreationClassName

[0629] Access Type: Read-only

[0630] CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[0631] string Description

[0632] Access Type: Read-only

[0633] The Description property provides a textual description of the object.

[0634] string DeviceID

[0635] Access Type: Read-only

[0636] DeviceID is an address or other identifying information to uniquely name the logical device.

[0637] boolean ErrorCleared

[0638] Access Type: Read-only

[0639] ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.

[0640] string ErrorDescription

[0641] Access Type: Read-only

[0642] ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.

[0643] string ErrorMethodology

[0644] Access Type: Read-only

[0645] ErrorMethodology is a free-form string describing the type of error detection and correction supported by this storage extent.

[0646] datetime InstallDate

[0647] Access Type: Read-only

[0648] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0649] uint32 LastErrorCode

[0650] Access Type: Read-only

[0651] LastErrorCode captures the last error code reported by the logical device.

[0652] key string Name

[0653] Access Type: Read-only

[0654] The Name property defines the label by which the object is known.

[0655] uint64 NumberOfBlocks

[0656] Total number of consecutive blocks, each block the size of the value contained in the BlockSize property, which form this storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1, this property is the total size of the storage extent.

[0657] string PhysicalLocation

[0658] Access Type: Read/Write

[0659] The PhysicalLocation property indicates the name of the backup device as known to the operating system For example, the string Seattle1BackupsNorthwind.bak specifies a server name, directory, and file name for a backup device. The string .TAPE0 specifies a server and a file device, most likely a tape, as a backup device.

[0660] string PNPDeviceID

[0661] Access Type: Read-only

[0662] Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP03

[0663] uint16 PowerManagementCapabilities

[0664] Access Type: Read-only

[0665] Indicates the specific power-related capabilities of the logical device. The array values, 0Unknown, 1 and 2Disabled are self-explanatory. The value, 3Enabled indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. Power Saving Modes Entered Automatically (4) describes that a device can change its power state based on usage or other criteria. Power State Settable (5) indicates that the SetPowerState method is supported. Power Cycling Supported (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (Power Cycle). Timed Power On Supported (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 (Power Cycle) and the Time parameter set to a specific date and time, or interval, for power-on.

Value	Description
0	Unknown
1	Not Supported
2	Disabled
3	Enabled
4	Power Saving Modes Entered Automatically
5	Power State Settable
6	Power Cycling Supported
7	Timed Power On Supported

[0666] boolean PowerManagementSupported

[0667] Access Type: Read-only

[0668] Indicates that the device can be power managedi.e. can be put into suspend mode, etc. This boolean does not indicate that power management features are currently enabled, only that the logical device is capable of power management.

[0669] string Purpose

[0670] Access Type: Read-only

[0671] A free form string describing the media and/or its use.

[0672] boolean SkipTapeLabel

[0673] Access Type: Read/Write

[0674] The SkipTapeLabel property indicates whether the verification to check that correct media is loaded is performed. If True, media headers are not written. An existing media header is ignored. If False, media headers are honored.

[0675] key string SQLServerName

[0676] Access Type: Read-only

[0677] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[0678] Maximum Length: 128

[0679] string Status

[0680] Access Type: Read-only

[0681] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0682] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0683] Maximum Length: 10

[0684] uint16 StatusInfo

[0685] Access Type: Read-only

[0686] StatusInfo is an integer value indicating the status of the logical device. If this property does not apply to the logical device, the value, 5 (Not Applicable), should be used.

Value	Description
1	Other
2	Unknown
3	Enabled
4	Disabled
5	Not Applicable

[0687] string SystemCreationClassName

[0688] Access Type: Read-only

[0689] The scoping system's CreationClassName.

[0690] string SystemName

[0691] Access Type: Read-only

[0692] The scoping system's name.

[0693] boolean SystemObject

[0694] Access Type: Read-only

[0695] The SystemObject property indicates whether the object is owned by

[0696] Microsoft. A value of True indicates that the object implementation is owned by Microsoft.

[0697] uint32 Type

[0698] Access Type: Read-only

[0699] The Type property indicates the type of the backup media.

Value	Description
2	Disk File
3	File On Removable Media In A: Drive
4	File On Removable Media In B: Drive
5	Tape
6	Named Pipe
7	CD-ROM
100	Unknown

[0700] Methods

[0701] The MSSQL_BackupDevice class supports the following methods:

Method Name	Description
ReadBackupHeader	The ReadBackupHeader method returns the header
	information for the data backed up on the
	backup device.
ReadMediaHeader	The ReadMediaHeader method returns an object
	enumerating the media header information for
	the backup device.
Reset	Requests a reset of the logical device.
	This method is not implemented for this class.
SetPowerState	SetPowerState defines the desired power state for
	a logical device and when a device should be put
	into that state. This method is not implemented
	for this class.

[0702] Associations

[0703] MSSQL_BackupDevice is associated to MSSQL_SQLServer as the Antecedent property of the MSSQL_SQLServerBackupDevice association.

[0704] MSSQL_BackupHeader

[0705] Abstract Class

[0706] The MSSQL_BackupHeader class represents the contents of the header record for backup content. The instances of this class are returned as results of the ReadBackupHeader method on the MSSQL_BackupDevice class.

[0707] Properties

[0708] string BackupDescription

[0709] The BackupDescription property describes the contents of the backup.

[0710] datetime BackupFinishDate

[0711] The BackupFinishDate property specifies the date and time that the backup operation finished.

[0712] string BackupName

[0713] The BackupName property indicates the name of the backup set.

[0714] Maximum Length: 130

[0715] uint32 BackupSize

[0716] The BackupSize property specifies the size of the backup in bytes.

[0717] Units: Bytes

[0718] datetime BackupStartDate

[0719] The BackupStartDate property specifies the date and time that the backup operation began.

[0720] uint32 BackupType

[0721] The BackupType property indicates the type of the backup content. The content could be a database, transaction log, file or differential database backup.

[0722] Maximum Length: 256

Value	Description
1	Database
2	Transaction Log
4	File
5	Differential Database

[0723] uint32 CheckpointLsn

[0724] The CheckpointLsn property specifies the log sequence number of the most recent checkpoint at the time the backup was created.

[0725] uint32 CodePage

[0726] The CodePage property specifies the server code page or character set used by the server.

[0727] uint32 CompatibilityLevel

[0728] The CompatibilityLevel property specifies the compatibility level setting of the database from which the backup was created.

Value	Description
0	Unknown
60	SQL Server 6.0
65	SQL Server 6.5
70	SQL Server 7.0
80	SQL Server 2000

[0729] boolean Compressed

[0730] The Compressed property indicates whether the backed up data is compressed. SQL Server does not currently support software compression; hence the value of this property is always FALSE.

[0731] uint32 DatabaseBackupLsn

[0732] The DatabaseBackupLsn property specifies the log sequence number of the most recent full database backup.

[0733] datetime DatabaseCreationDate

[0734] The DatabaseCreationDate property specifies the date and time the database was created.

[0735] string DatabaseName

[0736] The DatabaseName property specifies the name of the database that was backed up.

[0737] Maximum Length: 130

[0738] uint32 DatabaseVersion

[0739] The DatabaseVersion property specifies the version of the database from which the backup was created.

[0740] uint32 DeviceType

[0741] The DeviceType property specifies the type of device used for the backup operation.

Value	Description
2	Temporary disk device
5	Temporary tape device
6	Temporary named pipe device
7	Temporary virtual device
102	Permanent disk device
105	Permanent tape device
106	Permanent named pipe device
107	Permanent virtual device

[0742] datetime ExpirationDate

[0743] The ExpirationDate property indicates the expiration date for the backup set.

[0744] uint32 FirstLsn

[0745] The firstLsn property specifies the log sequence number of the first transaction in the backup set. This property is NULL for file backups.

[0746] uint32 LastLsn

[0747] The lastLsn property specifies the log sequence number of the last transaction in the backup set. This property is NULL for file backups.

[0748] string MachineName

[0749] The machineName property specifies the name of the computer that performed the backup operation.

[0750] Maximun Length: 130

[0751] uint32 Position

[0752] The Position property indicates the position of the backup set relative to the volume.

[0753] string ServerName

[0754] The ServerName property specifies the name of the server that wrote the backup set.

[0755] Maximum Length: 130

[0756] uint32 SoftwareVendorId

[0757] The SoftwareVendorld property specifies the software vendor identification number. For SQL Server, this number is 4608.

[0758] uint32 SoftwareVersionBuild

[0759] The SoftwareVersionBuild property specifies the build number of the server that created the backup set.

[0760] uint32 SoftwareVersionMajor

[0761] The SoftwareVersionMajor property specifies the major version number of the server that created the backup set.

[0762] uint32 SoftwareVersionMinor

[0763] The SoftwareVersionMinor property specifies the minor version number of the server that created the backup set.

[0764] uint32 SortOrder

[0765] The SortOrder property specifies the server sort order. This property is only valid for database backups.

[0766] string UserName

[0767] The UserName property specifies the name of the user that performed the backup operation.

[0768] Maximum Length: 130

[0769] MSSQL_BackupSetting: MSSQL_Setting

[0770] The MSSQL_BackupSetting class is used to specify the settings for a backup operation. An instance of this class is passed as an argument to the SQLBackup method on the MSSQL_SQLServer class.

[0771] Properties

[0772] string BackupSetDescription

[0773] Access Type: Read/Write

[0774] The BackupSetDescription property provides descriptive or identifying text for the result of a backup operation. The BackupSetDescription property value is limited to 255 characters. There is no default value.

[0775] Maximum Length: 255

[0776] string BackupSetName

[0777] Access Type: Read/Write

[0778] The BackupSetName property identifies a unit of backup work. The BackupSetName property value is limited to 128 characters.

[0779] Maximum Length: 128

[0780] sint32 BlockSize

[0781] Access Type: Read/Write

[0782] The BlockSize property specifies the formatting size unit for tapes, in bytes, formatted as part of a backup.

[0783] Units: Bytes

[0784] string Caption

[0785] Access Type: Read-only

[0786] A short textual description (one-line string) of the object.

[0787] Maximum Length: 64

[0788] string Database

[0789] Access Type: Read/Write

[0790] The Database identifies the source database for a for backup. The property is a required element and must be set prior to calling the SQLBackup method of the MSSQL_SQLServer class.

[0791] string DatabaseFileGroups

[0792] Access Type: Read/Write

[0793] The DatabaseFileGroups property identifies filegroups targeted by a backup or restore operation. Set to an empty string to reset processing and target the entire database.

[0794] string DatabaseFiles

[0795] Access Type: Read/Write

[0796] The DatabaseFiles property identifies operating system files storing table or index data as targets of a backup or restore operation. Set to an empty string to reset processing and target the entire database.

[0797] string Description

[0798] Access Type: Read-only

[0799] A textual description of the object.

[0800] string Device

[0801] Access Type: Read/Write

[0802] The Device property specifies one or more backup devices used as a database backup target source. Only one medium type can be specified for any backup or restore operation, but multiple media may be specified. Set the Devices property to specify one or more SQL Server backup devices as the backup medium. Specify more than a single database file to stripe the backup operation.

[0803] datetime ExpirationDate

[0804] Access Type: Read/Write

[0805] The ExpirationDate property specifies the last valid date for the backup data.

[0806] boolean FormatMedia

[0807] Access Type: Read/Write

[0808] The FormatMedia property controls tape formatting on a backup operation. The FormatMedia property applies only when the backup medium is tape. The property has no meaning for file or pipe media. If TRUE, the SQL Server backup operation attempts to format the tape as an initial step. If FALSE, the SQL Server backup operation does not attempt to format the tape.

[0809] boolean Initialize

[0810] Access Type: Read/Write

[0811] The Initialize property controls backup device append/overwrite behavior for a backup to one or more specified devices. If TRUE, the backup specified becomes the first backup set on the media, overwriting any existing backup sets on the media. The backup media is not overwritten if either of the following conditions is met: All backup sets on the media have not yet expired. The optionally specified backup set name does not match the name on the backup media. Specify backup set name with the BackupSetName property. If FALSE, the backup specified creates a new backup set appended as the last backup set on the media.

[0812] string MediaDescription

[0813] Access Type: Read/Write

[0814] The MediaDescription property provides informative text to aid in identification of a backup set. The MediaDescription property is written to a tape media when the media is initialized.

[0815] string MediaName

[0816] Access Type: Read/Write

[0817] The MediaName property provides informative text to aid in identification of a backup set. The MediaName property is are written to a tape media when the media is initialized.

[0818] boolean Restart

[0819] Access Type: Read/Write

[0820] The Restart property controls Backup object behavior when the backup operation was started and interrupted. If TRUE, SQL Server attempts to continue processing on a partial backup operation. If FALSE, SQL Server restarts an interrupted backup operation at the beginning of the backup set. Set the Restart property only when a user action or system error interrupts backup processing. When using the Restart property, the backup operation specified by the setting must match the originally specified setting in all particulars. Do not set any other properties for the object when setting the Restart property.

[0821] sint32 RetainDays

[0822] Access Type: Read/Write

[0823] The RetainDays property specifies the number of days that must elapse before a backup set can be overwritten.

[0824] key string SettingID

[0825] Access Type: Read/Write

[0826] The identifier by which the setting object is known.

[0827] Maximum Length: 256

[0828] boolean SkipTapeHeader

[0829] Access Type: Read/Write

[0830] The SkipTapeHeader property enables or disables backup operation logic that verifies that correct media is loaded. If TRUE, a media name recorded on the media is not checked. The backup set is appended to the media. If FALSE (default), a recorded media name is checked.

[0831] key string SQLServerName

[0832] Access Type: Read/Write

[0833] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[0834] Maximum Length: 128

[0835] uint32 TargetType

[0836] Access Type: Read/Write

[0837] The TargetType property controls the type of backup performed against a Microsoft SQL Server database. SQL Server can back up an entire database, that portion of a database changed after the last backup, one or more operating system files containing table or index data, or the transaction log of a database. The value of the TargetType property determines applicability and interpretation of related MSSQL_BackupSetting object properties. For example, when TargetType is Files, either the DatabaseFileGroups or DatabaseFiles property must specify filegroups or files to be backed up.

Value	Description	Explanation
0	Database	Backup the entire database.
1	Differential	Back up rows changed after the most recent
		full database or differential backup.
2	Files	Back up only specified files.
3	Log	Back up only the database transaction log.

[0838] uint32 TruncateLog

[0839] Access Type: Read/Write

[0840] The TruncateLog property controls log file processing during backup operations.

Value	Description	Explanation
0	Truncate	Default. Transaction log is backed up.
		Records referencing committed
		transactions are removed.
1	No truncate	Transaction log is backed up. Records
		referencing committed transactions are
		not removed, providing a point-in-time
		image of the log.
2	No Log	Records referencing committed transactions
		are removed. Transaction log is not
		backed up.

[0841] boolean UnloadTapeAfter

[0842] Access Type: Read/Write

[0843] The UnloadTapeAfter property controls tape media handling on completion of a backup or restore operation. If TRUE, the tape media in the tape device(s) is rewound and unloaded when the operation completes. If FALSE (default), no attempt is made to rewind and unload the tape media.

[0844] MSSQL_BaseDatatype: CIM_Dependency

[0845] Association Class

[0846] The MSSQL_BaseDatatype class represents an association between a user-defined datatype and the system datatype from which it is derived.

[0847] References

[0848] key MSSQL_SystemDatatype Antecedent

[0849] Access Type: Read-only

[0850] The Antecedent property references the system datatype from which the user defined datatype is derived.

[0851] key MSSQL_UserDatatype Dependent

[0852] Access Type: Read-only

[0853] The Dependent property references the user-defined datatype that is derived from the base system data type.

[0854] MSSQL_BulkCopySetting: MSSQL_Setting

[0855] The MSSQL_BulkCopySetting class represents the settings for importing or exporting data from a table or a view. It is used as a parameter in the ImportData and ExportData methods in the MSSQL_Table class, and ExportData in the MSSQL_View class.

[0856] Properties

[0857] string Caption

[0858] Access Type: Read-only

[0859] A short textual description (one-line string) of the setting object.

[0860] Maximum Length: 64

[0861] sint32 CodePage

[0862] Access Type: Read/Write

[0863] The CodePage property returns the identifier of the character set used by the referenced Microsoft SQL Server installation or is used to interpret data for a bulk-copy operation.A character set (code page) is used to interpret multibyte character data, determining character value, and therefore sort order. Code page settings apply only to multibyte character data, not to Unicode character data. A code page is chosen for a SQL Server installation during setup. By default, bulk-copy operations interpret character data assuming the code page used by the SQL Server installation that is either the source or the destination for the copied data.

[0864] string ColumnDelimiter

[0865] Access Type: Read/Write

[0866] The ColumnDelimiter property specifies one or more characters used to delimit a row of data in a bulk copy data file. The ColumnDelimiter property has meaning only when the DataFileType property is set to Special Delimted Char.

[0867] string DataFilePath

[0868] Access Type: Read/Write

[0869] The DataFilePath property indicates the target or source for the bulk copy operation. The operating system file specified by the DataFilePath property is the destination for the data copy performed by the ExportData method of MSSQL_Table and MSSQL_View objects. It is the source file for the ImportData method of MSSQL_Table objects.

[0870] uint32 DataFileType

[0871] Access Type: Read/Write

[0872] Microsoft SQL Server bulk copy operations can copy to or read from files containing data in a number of formats. Use the DataFileType property to indicate the format type of the file desired or in use.

Value	Description	Explanation
1	Comma Delimited Char	Columns are delimited using a
		comma character.
2	Tab Delimited Char	Columns are delimited using a
		tab character. Each data row
		is delimited by a carriage
		return/linefeed character
		pair.
3	Special Delimited Char	User-defined by the
		ColumnDelimiter and
		RowDelimiter properties.
4	Native Format	SQL Server bulk copy
		native format. When
		DataFileType property is
		Native Format, use the
		Use6xCompatible property to
		specify SQL Server version
		compatibility.
5	Use Format File	Bulk copy uses the file
		identified in the
		FormatFilePath property.

[0873] string Description

[0874] Access Type: Read-only

[0875] A textual description of the setting object.

[0876] string ErrorFilePath

[0877] Access Type: Read/Write

[0878] The ErrorFilePath property specifies the full path and full file name of a bulk copy operation error log file. SQL Server bulk copy operation logs errors to a file when an error file is provided at time of bulk copy initialization. When errors occur, the bulk copy operation continues to process rows until a maximum number of allowed errors is reached. If that maximum is reached, the error logging file is closed and the bulk copy operation stops. Set the MaximumErrorsBeforeAbort property to set the limiting number of allowed errors in a bulk copy operation.

[0879] boolean ExportWideChar

[0880] Access Type: Read/Write

[0881] The ExportWideChar property controls character set used in the data file when creating a data file by using the ExportData method of the MSSQL_Table and MSSQL_View class. If TRUE, the data file is created as a Unicode text file. If FALSE, the data file is created as a multibyte character text file. The ExportWideChar property is evaluated only when the MSSQL_BulkCopySetting object is used as an argument to the ExportData method, and the bulk-copy operation specifies a character format target file, i.e. the DataFileType property of the MSSQL BulkCopySetting object is Comma Delimited Char, Special Delimited Char, or Tab Delimited Char.

[0882] sint32 FirstRow

[0883] Access Type: Read/Write

[0884] The FirstRow property is an ordinal value defining the starting point for a bulk data copy When data is copied from SQL Server by using the ExportData method of a MSSQL_Table or MSSQL_View object, the FirstRow property indicates the starting row position in the SQL Server table. When data is copied to SQL Server by using the ImportData method of a MSSQL Table object, the FirstRow property indicates the starting row position in the source data file.

[0885] string FormatFilePath

[0886] Access Type: Read/Write

[0887] The FormatFilePath property indicates the path and file name of a bulk-copy format file. SQL Server bulk copy operations can use a user-specified data format stored in a text file. The property has meaning only when the DataFileType property is set to Use Format File.

[0888] sint32 ImportRowsPerBatch

[0889] Access Type: Read/Write

[0890] The lmportRowsPerBatch property specifies the number of rows contained in a bulk copy transaction. The SQL Server bulk copy process can copy large amounts of data from an external data file to a SQL Server table. By default, a bulk copy data-import operation inserts all rows in the data file in a single transaction. SQL Server does not guarantee data integrity until and unless a bulk copy transaction is committed. Use ImportRowsPerBatch to adjust the size of the bulk copy transaction.

[0891] boolean IncludeIdentityValues

[0892] Access Type: Read/Write

[0893] The IncludeIdentityValues property controls the handling of existing values for a column with the SQL Server identity property when data is copied to the SQL Server table. When TRUE, the SET IDENTITY_INSERT ON statement is executed when the ImportData method of a MSSQL_Table object is called. When FALSE, any data values present for a column with the identity property are ignored. SQL Server generates data values for the column by using the column's setting for identity seed and increment. The default is FALSE.

[0894] sint32 LastRow

[0895] Access Type: Read/Write

[0896] The LastRow property is an ordinal value defining the end point for a bulk data copy.When data is copied from SQL Server by using the ExportData method of a MSSQL_Table or MSSQL_View object, the Is property indicates the end row position in the SQL Server table. When data is copied to SQL Server by using the ImportData method of a MSSQL Table object, the property indicates the end row position in the source data file. The row will be the last one copied to the SQL Server table.

[0897] string LogFilePath

[0898] Access Type: Read/Write

[0899] The LogFilePath property specifies the full operating system path and file name for a bulk copy log file. A bulk copy log file contains statistics describing the number of rows copied and the processing time. It may also contain any non-bulk copy messages received from SQL Server during the bulk copy.

[0900] sint32 MaximumErrorsBeforeAbort

[0901] Access Type: Read/Write

[0902] The MaximumErrorsBeforeAbort property specifies the error limit for a bulk copy operation. The default is 10, and a bulk copy operation will stop when ten errors occur. Setting the property to a value greater than 65,535 results in use of the maximum, 65,535. An attempt to set the MaximumErrorsBeforeAbort property to a value less than 1 causes use of the default.

[0903] string RowDelimiter

[0904] Access Type: Read/Write

[0905] The RowDelimiter property specifies a character or character sequence that marks the end of a row in a Microsoft SQL Server bulk copy data file. The RowDelimiter property has meaning only when the DataFileType property is Special Delimted Char.

[0906] uint32 ServerBCPDataFileType

[0907] Access Type: Read/Write

[0908] The ServerBCPDataFileType property specifies the format for an imported data file. The ServerBCPDataFileType property is interpreted only when importing data and when the UseServerSideBCP property of the MSSQL_BulkCopySetting object is TRUE. When ServerBCPDataFileType is set to Char, specify a character set by using the CodePage property.

Value	Description	Explanation
1	Char	Read a data file as character data.
		Interpret the data file using the
		character set specified. This is the
		default.
2	Native	Assume bulk copy native data
		format when reading the data
		file.
4	Wide Char	Read a data file as Unicode
		character data.
8	Wide Native	Assume bulk copy wide native data
		format when reading the data file.

[0909] boolean ServerBCPKeepldentity

[0910] Access Type: Read/Write

[0911] The ServerBCPKeepIdentity property controls the handling of existing values for a column with the identity property when importing data into the column. When TRUE, NULL is inserted when missing values are encountered in the data file. The default constraint does not supply a value for the column. When FALSE (default), the default constraint provides a value for any missing values encountered in the data file. The ServerBCPKeepNulls property is interpreted only when importing data and when the UseServerSideBCP property of the MSSQL_BulkCopySetting object is TRUE.

[0912] boolean ServerBCPKeepNulls

[0913] Access Type: Read/Write

[0914] The ServerBCPKeepNulls property controls the handling of missing values for all columns accepting NULL and possessing a default value constraint when importing data. When TRUE, NULL is inserted when missing values are encountered in the data file. The default constraint does not supply a value for the column. When FALSE (default), the default constraint provides a value for any missing values encountered in the data file. The ServerBCPKeepNulls property is interpreted only when importing data and when the UseServerSideBCP property of is set to TRUE.

[0915] key string SettingID

[0916] Access Type: Read/Write

[0917] The identifier by which the setting object is known.

[0918] Maximum Length: 256

[0919] key string SQLServerName

[0920] Access Type: Read/Write

[0921] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[0922] Maximum Length: 128

[0923] boolean SuspendIndexing

[0924] Access Type: Read/Write

[0925] The SuspendIndexing property controls index update when the ImportData method of the MSSQL_Table class is used to copy data to SQL Server. If TRUE, indexes are dropped before the bulk copy operation is started and re-created after the bulk copy operation is completed. If FALSE, no changes are made to indexing. Note: Indexes that enforce referential or data integrity constraints, such as those implemented by SQL Server PRIMARY KEY or UNIQUE key constraints, are not dropped even when SuspendIndexing is TRUE.

[0926] boolean TableLock

[0927] Access Type: Read/Write

[0928] The TableLock property specifies whether to set table-level locking during the execution of a bulk copy import command. If TRUE, the table-level locking is used during the bulk copy import operation. The default is FALSE.

[0929] boolean TruncateLog

[0930] Access Type: Read/Write

[0931] The TruncateLog property controls log file processing upon completion of the ImportData method. If TRUE, the log file is truncated on successful completion of the lmportData method. If FALSE, the log file is not truncated regardless of the completion status of the ImportData method.

[0932] boolean Use6xCompatible

[0933] Access Type: Read/Write

[0934] The Use6xCompatible property controls interpretation of Microsoft SQL Server bulk copy native format data files. A SQL Server bulk copy operation either creates or reads from a data file. SQL Server bulk copy data files are created in either native (proprietary) or Scharacter format. SQL Server bulk copy native data file format has changed for SQL Server version 7.0. The user must direct version-dependent handling of source files when processing native format files created by an earlier version of SQL Server. If TRUE, a bulk copy operation interprets file data based on the pre-SQL Server 7.0 format for native data files. If FALSE, default, a bulk copy operation interprets file data based on the SQL Server 7.0 format.

[0935] boolean UseBulkCopyOption

[0936] Access Type: Read/Write

[0937] The UseBulkCopyoption property determines whether the select into/bulkcopy option is turned on automatically when the lmportData method of the MSSQL_Table object is executed. If TRUE, and the select into/bulkcopy database option is off in the target database, the option is turned on before an ImportData bulk copy is started and is turned off after the bulk copy is complete. If FALSE, no adjustments to the database options are made. Important: The select into/bulkcopy database option allows non-logged alteration to the target database. A target database should be backed up after any non-logged actions against it.

[0938] boolean UseServerSideBCP

[0939] Access Type: Read/Write

[0940] The UseServerSideBCP property controls the behavior of the bulk copy operation. The operation can be performed using either the bulk copy extensions to ODBC or the Transact-SQL BULK INSERT statement. When TRUE, the row import operation will be implemented by using the BULK INSERT statement. When FALSE (default), the row import or export operation will be implemented using extensions to the SQL Server ODBC driver.

[0941] MSSQL_CandidateKey: MSSQL_Key

[0942] Abstract Class

[0943] The MSSQL_CandidateKey class represents a candidate key in a SQL Server table. It consists of a set of columns that can uniquely identify a row in a table.

[0944] Properties

[0945] string Caption

[0946] Access Type: Read-only

[0947] The Caption property is a short textual description (one-line string) of the object.

[0948] Maximum Length: 64

[0949] key string DatabaseName

[0950] Access Type: Read-only

[0951] The DatabaseName property indicates the name of the database that the key is a part of.

[0952] Maximum Length: 128

[0953] string Description

[0954] Access Type: Read-only

[0955] The Description property provides a textual description of the object.

[0956] datetime InstallDate

[0957] Access Type: Read-only

[0958] The InstallDate property is a datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0959] key string Name

[0960] Access Type: Read-only

[0961] The Name property defines the label by which the object is known. The name of a key is unique within a database.

[0962] key string SQLServerName

[0963] Access Type: Read-only

[0964] The SQLServerName property indicates the name of the SQL Server installation that the key is a part of.

[0965] Maximum Length: 128

[0966] string Status

[0967] Access Type: Read-only

[0968] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[0969] Values are: Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[0970] Maximum Length: 10

[0971] key string TableName

[0972] Access Type: Read-only

[0973] The TableName property indicates the name of the table that the key is defined in.

[0974] Maximum Length: 128

[0975] Associations

[0976] MSSQL_CandidateKey is associated to MSSQL_FileGroup as the Dependent property of the MSSQL_KeyFileGroup association.

[0977] MSSQL_CandidateKey is associated to MSSQL_ForeignKey as the Antecedent property of the MSSQL_ReferencedKey association.

[0978] MSSQL_CandidateKey is associated to MSSQL_Database as the Containee property of the MSSQL_DatabaseCandidateKey association.

[0979] MSSQL_Check: MSSQL_Constraint

[0980] The MSSQL_Check class represents the attributes of a SQL Server integrity constraint.

[0981] Properties

[0982] string Caption

[0983] Access Type: Read-only

[0984] The Caption property is a short textual description (one-line string) of the object.

[0985] Maximum Length: 64

[0986] boolean Checked

[0987] Access Type: Read-only

[0988] The Checked property enables or disables integrity constraint evaluation for an existing integrity constraint. If TRUE, an attempt is made to enforce an integrity constraint when rows are added to the table on which the constraint is defined. If FALSE, no attempt is made to enforce the integrity constraint when rows are added to the table on which the constraint is defined.

[0989] key string DatabaseName

[0990] Access Type: Read-only

[0991] The DatabaseName property indicates the name of the database that the check is a part of.

[0992] Maximum Length: 128

[0993] string Description

[0994] Access Type: Read-only

[0995] The Description property provides a textual description of the object.

[0996] datetime InstallDate

[0997] Access Type: Read-only

[0998] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[0999] key string Name

[1000] Access Type: Read-only

[1001] The Name property defines the label by which the object is known.

[1002] key string SQLServerName

[1003] Access Type: Read-only

[1004] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1005] Maximum Length: 128

[1006] string Status

[1007] Access Type: Read-only

[1008] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1009] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1010] Maximum Length: 10

[1011] key string TableName

[1012] Access Type: Read-only

[1013] The TableName property indicates the name of the table that the check is defined in.

[1014] Maximum Length: 128

[1015] string Text

[1016] Access Type: Read/Write

[1017] The Text property indicates the Transact-SQL or other script that defines the object. Note that there is a special requirement for the name of the object is specified in the CREATE statement. The name of the object has to be in the form that includes the name of the owner. For example, in order to create an object named Some Object, one would need to specify it as dbo.Some Object.

[1018] Methods

[1019] The MSSQL_Check class supports the following methods:

	Method Name	Description
	Rename	The Rename method is used to rename
		a check instance.

[1020] Associations

[1021] MSSQL_Check is associated to MSSQL_Table as the Antecedent property of the MSSQL_TableCheck association.

[1022] MSSQL_Column: MSSQL_DBMSObject

[1023] The MSSQL_Column class represents columns in a SQL Server table.

[1024] Properties

[1025] boolean AllowNulls

[1026] Access Type: Read/Write

[1027] The AllowNulls property indicates the ability of a column to accept NULL as a value. If TRUE, the column can accept NULL as a value. If FALSE, NULL is not allowed.

[1028] boolean AnsiPaddingStatus

[1029] Access Type: Read-only

[1030] The AnsiPaddingStatus property returns TRUE if the column is defined to exhibit SQL-92 character padding behavior.

[1031] string Caption

[1032] Access Type: Read-only

[1033] The Caption property is a short textual description (one-line string) of the object.

[1034] Maximum Length: 64

[1035] string Collation

[1036] Access Type: Read/Write

[1037] The Collation property indicates the current collation of a string data type.

[1038] boolean Computed

[1039] Access Type: Read-only

[1040] The Computed property indicates whether the column is computed based on other values in the database.

[1041] string ComputedText

[1042] Access Type: Read/Write

[1043] The ComputedText property indicates Transact-SQL expression used to generate the value of a computed column.

[1044] key string DatabaseName

[1045] Access Type: Read-only

[1046] The DatabaseName property indicates the name of the database that the object is a part of.

[1047] Maximum Length: 128

[1048] string Datatype

[1049] Access Type: Read/Write

[1050] The Datatype property indicates the datatype for the column. It has to be the name of a valid system datatype or user defined datatype.

[1051] string Description

[1052] Access Type: Read-only

[1053] The Description property provides a textual description of the object.

[1054] boolean FullTextIndex

[1055] Access Type: Read/Write

[1056] The FullTextIndex property indicates whether the column is participating in Microsoft Search full-text queries. If TRUE, then the column is participating in full-text queries. FullTextIndex must be TRUE in a Table object before any Column object in the Columns collection can be set to TRUE.

[1057] boolean Identity

[1058] Access Type: Read-only

[1059] The Identity property indicates whether the column is the identity column for the table. SQL Server allows the row identity property on a single column within a table. Identity, like a primary key, identifies a row uniquely. SQL Server implements row identification using a numeric value. As rows are inserted, SQL Server generates the row value for an identity column by adding an increment to the existing maximum value.

[1060] sint32 IdentityIncrement

[1061] Access Type: Read-only

[1062] The IdentityIncrement property indicates the value by which the row identity value is incremented when SQL Server generates a new identity value. Identity, like a primary key, identifies a row uniquely. SQL Server implements row identification using a numeric value. As rows are inserted, SQL Server generates the row value for an identity column by adding an increment to the existing maximum value.

[1063] sint32 IdentitySeed

[1064] Access Type: Read-only

[1065] The IdentitySeed property exposes the initial row value for an identity column. Identity, like a primary key, identifies a row uniquely. SQL Server implements row identification using a numeric value. As rows are inserted, SQL Server generates the row value for an identity column by adding an increment to the existing maximum value.

[1066] datetime InstallDate

[1067] Access Type: Read-only

[1068] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1069] sint32 Length

[1070] Access Type: Read/Write

[1071] The Length property indicates the maximum number of characters or bytes accepted by the column. For columns containing character data types, such as char and nchar, interpret the Length property as a number of characters. For columns containing binary data types, such as varbinary, interpret the Length property as a number of bytes.

[1072] key string Name

[1073] Access Type: Read-only

[1074] The Name property defines the label by which the object is known.

[1075] boolean NotForRepl

[1076] Access Type: Read-only

[1077] The NotForRepl property enables or disables an identity constraint for data inserted by a replication process. If TRUE, the identity constraint is not enforced when data is added to the table by a known replication login. The replication process provides identity values. If FALSE, the identity constraint is enforced regardless of the source of the data.

[1078] sint32 NumericPrecision

[1079] Access Type: Read/Write

[1080] The NumericPrecision property specifies the maximum number of digits in a fixed-precision, numeric data type.

[1081] sint32 NumericScale

[1082] Access Type: Read/Write

[1083] The NumericScale property specifies the number of digits to the right of the decimal point in a fixed-precision, numeric data type.

[1084] boolean RowGuidCol

[1085] Access Type: Read/Write

[1086] The RowGuidCol indicates whether the column contains the globally unique identifier GUID for rows in table

[1087] key string SQLServerName

[1088] Access Type: Read-only

[1089] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1090] Maximum Length: 128

[1091] string Status

[1092] Access Type: Read-only

[1093] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1094] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1095] Maximum Length: 10

[1096] key string TableName

[1097] Access Type: Read-only

[1098] The TableName property indicates the name of the table that the key is defined in.

[1099] Maximum Length: 128

[1100] Methods

[1101] The MSSQL_Column class supports the following methods:

	Method Name	Description
	Rename	The Rename method is used to
		rename a column instance.
	UpdateStatisticsWith	The UpdateStatisticsWith method
		forces data distribution statistics
		update for a hypothetical index used
		to support data distribution
		statistics for the column.

[1102] Associations

[1103] MSSQL_Column is associated to MSSQL_Table as the PartComponent property of the MSSQL TableColumn association.

[1104] MSSQL_Column is associated to MSSQL_DRIDefault as the Dependent property of the MSSQL_ColumnDRIDefault association.

[1105] MSSQL_Column is associated to MSSQL_Datatype as the Dependent property of the MSSQL_ColumnDatatype association.

[1106] MSSQL_Column is associated to MSSQL_Index as the Antecedent property of the MSSQL IndexColumn association.

[1107] MSSQL_Column is associated to MSSQL_Key as the PartComponent property of the MSSQL_KeyColumn association.

[1108] MSSQL_Column is associated to MSSQL_Default as the Dependent property of the MSSQL_ColumnDefault association.

[1109] MSSQL_Column is associated to MSSQL_Rule as the Dependent property of the MSSQL_ColumnRule association.

[1110] MSSQL_ColumnDefault: CIM_Dependency

[1111] Association Class

[1112] The MSSQL_ColumnDefault class associates a column to the default for the column.

[1113] References

[1114] key MSSQL_Default Antecedent

[1115] Access Type: Read-only

[1116] The Antecedent property references the default that applies to a column in the database.

[1117] key MSSQL_Column Dependent

[1118] Access Type: Read-only

[1119] The Dependent property references a column in the database.

[1120] MSSQL_ColumnDRIDefault: CIM_Dependency

[1121] Association Class

[1122] The MSSQL_ColumnDRIDefault class associates a column to a DRI default.

[1123] References

[1124] key MSSQL_DRIDefault Antecedent

[1125] Access Type: Read-only

[1126] The Antecedent property references a DRI Default defined for the column.

[1127] key MSSQL_Column Dependent

[1128] Access Type: Read-only

[1129] The Dependent property references a column in the database.

[1130] MSSQL_ColumnRule: CIM_Dependency

[1131] Association Class

[1132] The MSSQL_ColumnRule class represents an association between a column and a rule bound to the column.

[1133] References

[1134] key MSSQL_Rule Antecedent

[1135] Access Type: Read-only

[1136] The Antecedent property references a rule constraint defined in the database.

[1137] key MSSQL_Column Dependent

[1138] Access Type: Read-only

[1139] The Dependent property references a column in the database.

[1140] MSSQL_ColumnDatatype: CIM_Dependency

[1141] Association Class

[1142] The MSSQL_ColumnDatatype class associates a column its data type.

[1143] References

[1144] key MSSQL_Datatype Antecedent

[1145] Access Type: Read-only

[1146] The Antecedent property references the data type of the column.

[1147] key MSSQL_Column Dependent

[1148] Access Type: Read-only

[1149] The Dependent property references a column in the database.

[1150] MSSQL_ConrigValue: MSSQL_Setting

[1151] The MSSQL_ConfigValue class represents the SQL Server configuration values. Some SQL Server configuration options do not take effect until the SQL Server service has been stopped and restarted. You can force the server to immediately accept changes in some options by using the ReconfigureWithOverride method. The DynamicReconfigure property indicates whether the ConfigValue object requires a restart.

[1152] Properties

[1153] string Caption

[1154] Access Type: Read-only

[1155] A short textual description (one-line string) of the object.

[1156] Maximum Length: 64

[1157] sint32 CurrentValue

[1158] Access Type: Read/Write

[1159] The CurrentValue property specifies the current configuration parameter value. The MinimumValue and MaximumValue properties provide the range of values acceptable for the CurrentValue property.

[1160] string Description

[1161] Access Type: Read-only

[1162] The Description property returns a text description of the configuration value.

[1163] boolean DynamicReconfigure

[1164] Access Type: Read-only

[1165] The DynamicReconfigure property indicates modifiability of the configuration value. If TRUE, a modification to the value is effective immediately. If FALSE, modifications are visible only after the SQL Server service has been stopped and restarted.

[1166] uint32 ID

[1167] Access Type: Read-only

[1168] The Id property returns a unique identifier for the configuration value. The ID is assigned by SQL Server.

Value	Description
101	Recovery Interval
102	Allow Updates
103	User Connections
106	Locks
107	Open Objects
109	Fill Factor
115	Nested Triggers
117	Remote Access
124	Default Language
125	Language In Cache
502	Max Async I/O
503	Max Worker Threads
505	Network Packet Size
518	Show Advanced Option
542	Remote Proc Trans
543	Remote Conn Timeout
1110	Time Slice
1123	Default Sort order Id
1124	Unicode Local ID
1125	Unicode Comparison Style
1126	Language Neutral
1127	Two Digit Year Cutoff
1505	Index Create Mem
1514	Spin Counter
1517	Priority Boost
1519	Remote Login Timeout
1520	Remote Query Timeout
1531	Cursor Threshold
1532	Set Working Set Size
1533	Resource Timeout
1534	User Options
1535	Processor Affinity Mask
1536	Max Text Repl Size
1537	Media Retention
1538	Cost Threshold For Parallelism
1539	Max Degree Of Parallelism
1540	Min Memory Per Query
1541	Query Wait
1542	VLM Size
1543	Min Memory
1544	Max Memory
1545	Query Max Time
1546	Lightweight Pooling

[1169] sint32 MaximumValue

[1170] Access Type: Read-only

[1171] The MaximumValue property specifies an upper bound for a configuration value.

[1172] sint32 MinimumValue

[1173] Access Type: Read-only

[1174] The MinimumValue property specifies a lower bound for a configuration value.

[1175] sint32 RunningValue

[1176] Access Type: Read-only

[1177] The RunningValue property returns the setting used by SQL Server for the configuration option. Prior to changing a configurable SQL Server operating setting, the RunningValue and CurrentValue properties are identical for the ConfigValue object referencing that setting. A change is made to the setting by using the CurrentValue property, and the values will vary as changes are applied.

[1178] key string SettingID

[1179] Access Type: Read-only

[1180] The identifier by which the setting object is known.

[1181] Maximum Length: 256

[1182] key string SQLServerName

[1183] Access Type: Read-only

[1184] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1185] Maximum Length: 128

[1186] Associations

[1187] MSSQL_ConfigValue is associated to MSSQL_SQLServer as the Setting property of the MSSQL_SQLServerConfigValue association.

[1188] MSSQL_Constraint: MSSQL_DBMSObject

[1189] Abstract Class

[1190] The MSSQL_Constraint class represents constraints defined in the Microsoft SQL Server database. There are three types of constraints that can be definedchecks, keys and rules.

[1191] Properties

[1192] string Caption

[1193] Access Type: Read-only

[1194] The Caption property is a short textual description (one-line string) of the object.

[1195] Maximum Length: 64

[1196] string Description

[1197] Access Type: Read-only

[1198] datetime InstallDate

[1199] Access Type: Read-only

[1200] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1201] string Name

[1202] Access Type: Read-only

[1203] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[1204] string Status

[1205] Access Type: Read-only

[1206] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1207] Values are: OK,Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1208] Maximum Length: 10

[1209] MSSQL_Containment

[1210] Abstract Class

[1211] Association Class

[1212] The MSSQL_Containment class represents an association between a container and the contained object.

[1213] References

[1214] CIM_ManagedSystemElement Containee

[1215] Access Type: Read-only

[1216] The Containee property references a managed system element that is contained within another managed system element.

[1217] CIM_ManagedSystemElement Container

[1218] Access Type: Read-only

[1219] The Container property references a managed system element that contains one or more other managed system elements.

[1220] MSSQL_Database: MSSQL_DBMSObject

[1221] The MSSQL_Database class represents instances of SQL Server databases.

[1222] Properties

[1223] string Caption

[1224] Access Type: Read-only

[1225] The Caption property is a short textual description (one-line string) of the object.

[1226] Maximum Length: 64

[1227] string Collation

[1228] Access Type: Read/Write

[1229] The Collation property specifies the column-level collation of a string datatype in the database. A Collation setting for a Database object overrides the default collation specified in the model database. All tables in the database then inherit the Collation setting.

[1230] uint32 CompatibilityLevel

[1231] Access Type: Read/Write

[1232] The CompatibilityLevel property controls Microsoft SQL Server behavior, setting behavior to match either the current or earlier version (default is 70).

Value	Description
0	Unknown
60	SQL Server 6.0
65	SQL Server 6.5
70	SQL Server 7.0
80	SQL Server 2000

[1233] datetime CreateDate

[1234] Access Type: Read-only

[1235] The CreateDate property indicates the time and date on which the database was created. Note that creation date may be different from the install date in cases where the object is created in one place and then installed elsewhere.

[1236] boolean CreateForAttach

[1237] Access Type: Read-only

[1238] The CreateForAttach property controls database file creation and specifies whether a database is attached from an existing set of operating system files.

[1239] uint32 DatabaseStatus

[1240] Access Type: Read-only

[1241] The DatabaseStatus property reflects the current operational status on the database. The database is inaccessible when the status is Loading, Offline, Recovering or Suspect.

Value	Description
0	Normal
32	Loading
192	Recovering
256	Suspect
512	Offline
1024	Standby
32768	Emergency Mode

[1242] string Description

[1243] Access Type: Read-only

[1244] The Description property provides a textual description of the object.

[1245] boolean FullTextEnabled

[1246] Access Type: Read-only

[1247] The FullTextEnabled property is TRUE when the referenced database has been selected for participation in Microsoft Search full-text queries.

[1248] datetime InstallDate

[1249] Access Type: Read-only

[1250] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1251] key string Name

[1252] Access Type: Read-only

[1253] The Name property defines the label by which the object is known.

[1254] string PrimaryFilePath

[1255] Access Type: Read-only

[1256] The PrimaryFilePath property returns the path and name of the operating system directory containing the primary file for the database.

[1257] sint32 Size

[1258] Access Type: Read-only

[1259] The Size property exposes the total size, in megabytes, of the database.

[1260] Units: MegaBytes

[1261] sint32 SpaceAvailable

[1262] Access Type: Read-only

[1263] The SpaceAvailable property returns the amount of disk resource allocated in kilobytes and unused in operating system files implementing Microsoft SQL Server database storage.

[1264] key string SQLServerName

[1265] Access Type: Read-only

[1266] The SQLServerName property indicates the name of the SQL Server installation that the database is a part of.

[1267] Maximum Length: 128

[1268] string Status

[1269] Access Type: Read-only

[1270] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1271] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1272] Maximum Length: 10

[1273] boolean SystemObject

[1274] Access Type: Read-only

[1275] The SystemObject property indicates whether the object is owned by Microsoft. A value of TRUE indicates that the object implementation is owned by Microsoft.

[1276] sint32 Version

[1277] Access Type: Read-only

[1278] The Version property returns a system-specified integer identifying the version of Microsoft SQL Server used to create the referenced database.

[1279] Methods

[1280] The MSSQL_Database class supports the following methods:

Method Name	Description
CheckAllocations	The CheckAllocations method scans
	all pages of the referenced
	Microsoft SQL Server database,
	testing pages to ensure integrity.
CheckCatalog	The CheckCatalog method tests the
	integrity of the catalog of the
	referenced database.
CheckldentityValues	The CheckldentityValues method
	verifies the integrity of all
	identity columns in tables of the
	referenced database.
Checkpoint	The Checkpoint method forces a
	write of dirty database pages.
CheckTables	The CheckTables method tests the
	integrity of database pages
	implementing storage for all tables
	and indexes defined on the tables
	of the database.
CheckTablesDataOnly	The CheckTablesDataOnly method tests
	the integrity of database pages
	implementing storage for all tables
	in the referenced database.
Create	The Create method is used to create
	a new database.
DisableFullTextCatalogs	The DisableFullTextCatalogs method
	suspends Microsoft Search
	full-text catalog maintenance on
	the database.
EnableFullTextCatalogs	The EnableFullTextCatalogs method
	enables Microsoft Search full-text
	indexing on the referenced
	Microsoft SQL Server
	database.
EnumerateStoredProcedures	The EnumerateStoredProcedures
	method searches stored procedures
	and returns those that contain a
	specified string.
ExecuteImmediate	The ExecuteImmediate method allows
	any SQL Server command to be
	executed, as long as the command
	doesn't return result sets.
FullTextIndexScript	The FullTextIndexScript method
	returns a Transact-SQL command
	batch enabling Microsoft Search
	full-text indexing on a database or
	table.
IsValidKeyDatatype	The IsValidKeyDatatype method
	returns TRUE when the data type
	specified can participate in a
	PRIMARY KEY or FOREIGN KEY
	constraint.
RecalcSpaceUsage	The RecalcSpaceUsage method forces
	the update of data reporting the disk
	resource usage of the referenced
	Microsoft SQL Server
	database.
RemoveFullTextCatalogs	The RemoveFullTextCatalogs method
	drops all Microsoft Search
	full-text catalogs supporting full-text
	query on a Microsoft SQL Server
	database.
Rename	The Rename method is used to rename
	the database instance.
Shrink	The Shrink method attempts to reduce
	the size of all operating system files
	maintaining the database.
Transfer	The Transfer method copies database
	schema and/or data from one
	Microsoft SQL Server database
	to another.
UpdatelndexStatistics	The UpdatelndexStatistics method
	forces data distribution statistics
	update for all indexes on user-defined
	tables in the referenced
	Microsoft SQL Server database.

[1281] Associations

[1282] MSSQL_Database is associated to MSSQL_SQLServer as the PartComponent property of the MSSQL_SQLServerDatabase association.

[1283] MSSQL_Database is associated to MSSQL_DatabaseSetting as the Element property of the MSSQL_DatabaseDatabaseSetting association.

[1284] MSSQL_Database is associated to MSSQL_FileGroup as the Dependent property of the MSSQL_DatabaseFileGroup association.

[1285] MSSQL_Database is associated to MSSQL_DatabaseRole as the ScopingElement property of the MSSQL_DatabaseDatabaseRole association.

[1286] MSSQL_Database is associated to MSSQL_Table as the GroupComponent property of the MSSQL_DatabaseTable association.

[1287] MSSQL_Database is associated to MSSQL_StoredProcedure as the ScopingElement property of the MSSQL_DatabaseStoredProcedure association.

[1288] MSSQL_Database is associated to MSSQL_User as the ScopingElement property of the MSSQL_DatabaseUser association.

[1289] MSSQL_Database is associated to MSSQL_View as the GroupComponent property of the MSSQL_DatabaseView association.

[1290] MSSQL_Database is associated to MSSQL_Datatype as the ScopingElement property of the MSSQL_DatabaseDatatype association.

[1291] MSSQL_Database is associated to MSSQL_Login as the Dependent property of the MSSQL_LoginDefaultDatabase association.

[1292] MSSQL_Database is associated to MSSQL_Login as the Dependent property of the MSSQL_DatabaseOwnerLogin association.

[1293] MSSQL_Database is associated to MSSQL_User as the Element property of the MSSQL_UserDatabasePermission association.

[1294] MSSQL_Database is associated to MSSQL_DatabaseRole as the Element property of the MSSQL_DatabaseRoleDatabasePermission association.

[1295] MSSQL_Database is associated to MSSQL_UserDefinedFunction as the ScopingElement property of the MSSQL_DatabaseUserDefinedFunction association.

[1296] MSSQL_Database is associated to MSSQL_Rule as the ScopingElement property of the MSSQL_DatabaseRule association.

[1297] MSSQL_Database is associated to MSSQL_Default as the ScopingElement property of the MSSQL_DatabaseDefault association.

[1298] MSSQL_Database is associated to MSSQLCandidateKey as the Container property of the MSSQL_DatabaseCandidateKey association.

[1299] MSSQL_Database is associated to MSSQL_Login as the Container property of the MSSQL_DatabaseLogin association.

[1300] MSSQL_Database is associated to MSSQL_TransactionLog as the Dependent property of the MSSQL_DatabaseTransactionLog association.

[1301] MSSQL_DatabaseCandidateKey: MSSQL_Containment

[1302] Association Class

[1303] The MSSQL_DatabaseCandidateKey class represents an association between a database and a candidate key that is present in one of the tables in the database. This association allows an application to perform a single traversal to find the candidate keys in a database.

[1304] References

[1305] key MSSQL_CandidateKey Containee

[1306] Access Type: Read-only

[1307] The Containee property references a candidate key that is contained within the database.

[1308] key MSSQL_Database Container

[1309] Access Type: Read-only

[1310] The Container property references a database that contains the candidate key referenced by the Containee property.

[1311] MSSQL_DatabaseDatabaseRole: MSSQL_Scope

[1312] Association Class

[1313] The MSSQL_DatabaseDatabaseRole class associates database role to the database within which the role is defined.

[1314] References

[1315] key MSSQL_DatabaseRole ScopedElement

[1316] Access Type: Read-only

[1317] The ScopedElement property references a database role that is defined within the scope of the database referenced by the ScopingElement property.

[1318] key MSSQL_Database ScopingElement

[1319] Access Type: Read-only

[1320] The ScopingElement property references a database in SQL.

[1321] MSSQL_DatabaseDatabaseSetting: CIM_ElementSetting

[1322] Association Class

[1323] The MSSQL_DatabaseDatabaseSetting class associates a SQL Server database to an instance of the MSSQL_DatabaseSetting class that contains the settings for the database.

[1324] References

[1325] key MSSQL_Database Element

[1326] Access Type: Read-only

[1327] The Element property references a SQL Server database.

[1328] key MSSQL_DatabaseSetting Setting

[1329] Access Type: Read-only

[1330] The Setting property references a class that represents the settings for a database.

[1331] MSSQL_DatabaseDatatype: MSSQL_Scope

[1332] Association Class

[1333] The MSSQL_DatabaseDatatype class associates a database to the datatypes defined within the database.

[1334] References

[1335] key MSSQL_Datatype ScopedElement

[1336] Access Type: Read-only

[1337] The ScopedElement property references the data type that has been defined within the database.

[1338] key MSSQL_Database ScopingElement

[1339] Access Type: Read-only

[1340] The ScopingElement property references the database within which the data type has been defined.

[1341] MSSQL_DatabaseDefault: MSSQL_Scope

[1342] Association Class

[1343] The MSSQL_DatabaseDefault association associates a database to the defaults defined within the database.

[1344] References

[1345] key MSSQL_Default ScopedElement

[1346] Access Type: Read-only

[1347] The ScopedElement property references a default constraint defined within the database.

[1348] key MSSQL_Database ScopingElement

[1349] Access Type: Read-only

[1350] The ScopingElement property references a SQL Server database.

[1351] MSSQL_DatabaseFile: MSSQL_Extension

[1352] The MSSQL_DatabaseFile class is an extension to the CIM_DataFile class. It contains properties that are relevant to an operating system file that is also a file storing SQL Server database data.

[1353] Properties

[1354] key string DatabaseName

[1355] Access Type: Read-only

[1356] The DatabaseName property indicates the name of the database that the object is a part of.

[1357] Maximum Length: 128

[1358] key string FileGroupName

[1359] Access Type: Read-only

[1360] The FileGroupName property indicates the name of the database file group that the database file is a part of.

[1361] Maximum Length: 128

[1362] sint32 FileGrowth

[1363] Access Type: Read/Write

[1364] The FileGrowth property indicates the growth increment of the operating system file used to store table, index, or log data. When FileGrowthType is Megabytes, the FileGrowth value represents the number of megabytes of disk space to allocate for incremental file growth. When FileGrowthType is Percent, the value represents a percentage and must be in the range from 1 through 100.

[1365] real32 FileGrowthInKB

[1366] Access Type: Read-only

[1367] The FileGrowthInKB property reports the number of kilobytes of disk space allocated when an incremental increase occurs on an operating system file.

[1368] uint32 FileGrowthType

[1369] Access Type: Read/Write

[1370] The FileGrowthType property indicates the method of incremental allocation applied when an operating system file is extended.

Value	Description
0	Megabyte
1	Percent
99	Invalid

[1371] sint32 MaximumSize

[1372] Access Type: Read/Nrite

[1373] The MaximumSize property indicates an upper limit for the size of an operating system file containing table and index data, or maintaining a database transaction log.

[1374] key string Name

[1375] Access Type: Read-only

[1376] The Name property defines the label by which the object is known.

[1377] Maximum Length: 128

[1378] string PhysicalName

[1379] Access Type: Read-only

[1380] The PhysicalName property specifies the path and file name of the operating system file storing Microsoft SQL Server database or transaction log data.

[1381] boolean PrimaryFile

[1382] Access Type: Read-only

[1383] The PrimaryFile property indicates whether the database file is the one that maintains the database-specific system tables. A SQL Server database can have at most one primary file.

[1384] sint32 SpaceAvailableInMB

[1385] Access Type: Read-only

[1386] The SpaceAvailableInMB property returns the amount of disk resource, in megabytes, allocated and unused in operating system files implementing Microsoft SQL Server database and database transaction log storage.

[1387] Units: Megabytes

[1388] key string SQLServerName

[1389] Access Type: Read-only

[1390] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1391] Maximum Length: 128

[1392] Methods

[1393] The MSSQL_DatabaseFile class supports the following methods:

Method Name	Description
Shrink	The Shrink method attempts to reduce the size of the
	database file.

[1394] MSSQL_DatabaseFileDataFile: MSSQL_Extends

[1395] Association Class

[1396] The MSSQL_DatabaseFileDataFile class associates a CIM_DataFile class to the MSSQL_DatabaseFile class that contains database file specific properties of an operating system file.

[1397] key CIM_DataFile ExtendedElement

[1398] Access Type: Read-only

[1399] The ExtendedElement property references an operating system file.

[1400] key MSSQL_DatabaseFile Extension

[1401] Access Type: Read-only

[1402] The Extension property references an instance that contains database file specific extensions to an operating system file.

[1403] MSSQL_DatabaseFileGroup: CIM_Dependency

[1404] Association Class

[1405] The MSSQL_DatabaseFileGroup class represents an association between a database and the file group that contains the operating system files that store the data for the database.

[1406] References

[1407] key MSSQL_FileGroup Antecedent

[1408] Access Type: Read-only

[1409] The Antecedent property references the file group that contains the operating system files of the database.

[1410] key MSSQL_Database Dependent

[1411] Access Type: Read-only

[1412] The Dependent property references a SQL Server database.

[1413] MSSQL_DatabaseFullTextCatalog: CIM_Dependency

[1414] Association Class

[1415] The MSSQL_DatabaseFullTextCatalog class represents an association between a database and a full-text catalog that stores index data used for full-text queries against the database.

[1416] References

[1417] key MSSQL_FullTextCatalog Antecedent

[1418] Access Type: Read-only

[1419] The Antecedent property references a full-text catalog that stores index data used for full-text queries against the database referenced by the Dependent property.

[1420] key MSSQL_Database Dependent

[1421] Access Type: Read-only

[1422] The Dependent property references a Microsoft SQL Server database.

[1423] MSSQL_DatabaseLogin: MSSQL_Containment

[1424] Association Class

[1425] The MSSQL_Containment class represents an association between a database and a login that is mapped to a user defined in the database. This association allows an application to perform a single traversal to find the logins used by a database.

[1426] Properties

[1427] key string UserName

[1428] Access Type: Read-only

[1429] This property indicates the database user that is mapped to the login.

[1430] Maximum Length: 128

[1431] References

[1432] key MSSQL_Login Containee

[1433] Access Type: Read-only

[1434] The Containee property references a managed system element that is contained within another managed system element.

[1435] key MSSQL_Database Container

[1436] Access Type: Read-only

[1437] The Container property references a managed system element that contains one or more other managed system elements.

[1438] MSSQL_DatabaseOwnerLogin: CIM_Dependency

[1439] Association Class

[1440] The MSSQL_DatabaseOwnerLogin class represents an association between a database and the login mapped to the user that owns the database.

[1441] References

[1442] key MSSQL_Login Antecedent

[1443] Access Type: Read-only

[1444] The Antecedent property references the login mapped to the user that owns the database referenced by the Dependent property.

[1445] key MSSQL_Database Dependent

[1446] Access Type: Read-only

[1447] The Dependent property references a SQL Server database.

[1448] MSSQL_DatabaseRole: MSSQL_Role

[1449] The DatabaseRole object represents the properties of a SQL Server database role. SQL Server database roles establish groups of users with similar security attributes. Database permissions can be granted by role, simplifying database security planning and administration.

[1450] Properties

[1451] boolean AppRole

[1452] Access Type: Read-only

[1453] The AppRole property indicates the whether the database role has been defined specifically for use by client applications.

[1454] string Caption

[1455] Access Type: Read-only

[1456] The Caption property is a short textual description (one-line string) of the object.

[1457] Maximum Length: 64

[1458] key string DatabaseName

[1459] Access Type: Read-only

[1460] The DatabaseName property indicates the name of the database that the object is a part of.

[1461] Maximum Length: 128

[1462] string Description

[1463] Access Type: Read-only

[1464] The Description property provides a textual description of the object.

[1465] boolean FixedRole

[1466] Access Type: Read-only

[1467] The FixedRole property returns True when the database role referenced is system-defined.

[1468] datetime InstallDate

[1469] Access Type: Read-only

[1470] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1471] key string Name

[1472] Access Type: Read-only

[1473] The Name property indicates a label by which the role can be identified.

[1474] string Password

[1475] Access Type: Write-only

[1476] The Password property is used to set the password for an application role. The property cannot be read. It can be written at the time the database role object is created.

[1477] key string SQLServerName

[1478] Access Type: Read-only

[1479] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1480] Maximum Length: 128

[1481] string Status

[1482] Access Type: Read-only

[1483] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1484] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1485] Maximum Length: 10

[1486] Associations

[1487] MSSQL_DatabaseRole is associated to MSSQL_Database as the ScopedElement property of the MSSQL_DatabaseDatabaseRole association.

[1488] MSSQL_DatabaseRole is associated to MSSQL_User as the Antecedent property of the MSSQL_MemberUser association.

[1489] MSSQL_DatabaseRole is associated to MSSQL_UserDefinedFunction as the Grantee property of the MSSQL_DatabaseRoleUserDefinedFunctionPermission association.

[1490] MSSQL_DatabaseRole is associated to MSSQL_Database as the Grantee property of the MSSQL_DatabaseRoleDatabasePermission association.

[1491] MSSQL_DatabaseRole is associated to MSSQL_StoredProcedure as the Grantee property of the MSSQL_DatabaseRoleStoredProcedurePermission association.

[1492] MSSQL_DatabaseRole is associated to MSSQL_View as the Grantee property of the MSSQL_DatabaseRoleViewPermission association.

[1493] MSSQL_DatabaseRole is associated to MSSQL_Table as the Grantee property of the MSSQL_DatabaseRoleTablePermission association.

[1494] MSSQL_DatabaseRole is associated to MSSQL_DatabaseRole as the Antecedent property of the MSSQL_MemberDatabaseRole association.

[1495] MSSQL_DatabaseRole is associated to MSSQL_DatabaseRole as the Dependent property of the MSSQL_MemberDatabaseRole association. MSSQL_DatabaseRoleDatabasePermission: MSSQL_Permission

[1496] Association Class

[1497] The MSSQL_DatabaseRoleDatabasePermission class represents the permissions that a database role has for the database in which it is defined. The instances of this class represent only the permission that has been explicitly granted or denied to the user object. For example, if a database role has permissions to access a database by virtue of being a member of another database role, then there will not be a permission association instance between the role and the database.

[1498] Properties

[1499] boolean Granted

[1500] Access Type: Read/Write

[1501] The Granted property indicates whether the permission has been granted or denied. A value of True indicates that the permission has been granted. A value of False indicates that permission has been denied.

[1502] key uint32 PrivilegeType

[1503] Access Type: Read/Write

[1504] The PrivilegeType property indicates the type of privilege that has been granted or denied.

Value	Description
0	Unknown
1	Permission to query a table
2	Permission to add rows to a table
4	Permission to update rows of a table
8	Permission to delete rows of a table
16	Permission to execute a stored procedure
32	Permission to grant DRI on a table
63	All privileges applicable to the database object
128	Permission to create and own a table
256	Permission to create and own a database
512	Permission to create and own a view
1024	Permission to create and own a stored procedure
2048	Permission to backup a database
4096	Permission to create a default
8192	Permission to backup a database transaction log
16384	Permission to create a rule
32768	Permission to backup to a table
65366	Permission to create a user defined function
130944	All privileges applicable to the database

[1505] References

[1506] key MSSQL_Database Element

[1507] Access Type: Read/Write

[1508] The Element property references a SQL Server database.

[1509] key MSSQL_DatabaseRole Grantee

[1510] Access Type: Read/Write

[1511] The Grantee property references a database role that has been granted or denied permission to access the database.

[1512] MSSQL_DatabaseRoleStoredProcedurePermission: MSSQL_Permission

[1513] Association Class

[1514] The MSSQL_DatabaseRoleStoredProcedurePermission class represents the permissions that a database role has for a stored procedure. The instances of this class represent only the permission that has been explicitly granted or denied to the user object. For example, if a database role has permissions to access the stored procedure by virtue of being a member of another database role, then there will not be a permission association instance between the role and the stored procedure.

[1515] Properties

[1516] boolean Granted

[1517] Access Type: Read/Write

[1518] The Granted property indicates whether the permission has been granted or denied. A value of True indicates that the permission has been granted. A value of False indicates that permission has been denied.

[1519] key uint32 PrivilegeType

[1520] Access Type: Read/Write

[1521] The PrivilegeType property indicates the type of privilege that has been granted or denied.

Value	Description
0	Unknown
1	Permission to query a table
2	Permission to add rows to a table
4	Permission to update rows of a table
8	Permission to delete rows of a table
16	Permission to execute a stored procedure
32	Permission to grant DRI on a table
63	All privileges applicable to the database object
128	Permission to create and own a table
256	Permission to create and own a database
512	Permission to create and own a view
1024	Permission to create and own a stored procedure
2048	Permission to backup a database
4096	Permission to create a default
8192	Permission to backup a database transaction log
16384	Permission to create a rule
32768	Permission to backup to a table
65366	Permission to create a user defined function
130944	All privileges applicable to the database

[1522] References

[1523] key MSSQL_StoredProcedure Element

[1524] Access Type: Read/Write

[1525] The Element property references a stored procedure in the database.

[1526] key MSSQL_DatabaseRole Grantee

[1527] Access Type: Read/Write

[1528] The Grantee property references a database role for which the permissions have been defined.

[1529] MSSQL_DatabaseRoleTablePermission: MSSQL_Permission

[1530] Association Class

[1531] The MSSQL_DatabaseRoleTablePermission class represents the permissions that a database role has for a table. The instances of this class represent only the permissions that have been explicitly granted or denied to the user object. For example, if a database role has permissions to access the table by virtue of being a member of another database role, then there will not be a permission association instance between the role and the table.

[1532] Properties

[1533] string ColumnName

[1534] Access Type: Read/Write

[1535] The ColumnName property specifies the columns within the table for which the permission is specified. If this property is null, then the permission applies to all columns in the table, otherwise it applies only to the columns indicated in this property.

[1536] boolean Granted

[1537] Access Type: Read/Write

[1538] The Granted property indicates whether the permission has been granted or denied. A value of True indicates that the permission has been granted. A value of False indicates that permission has been denied.

[1539] key uint32 PrivilegeType

[1540] Access Type: Read/Write

[1541] The PrivilegeType property indicates the type of privilege that has been granted or denied.

Value	Description
0	Unknown
1	Permission to query a table
2	Permission to add rows to a table
4	Permission to update rows of a table
8	Permission to delete rows of a table
16	Permission to execute a stored procedure
32	Permission to grant DRI on a table
63	All privileges applicable to the database object
128	Permission to create and own a table
256	Permission to create and own a database
512	Permission to create and own a view
1024	Permission to create and own a stored procedure
2048	Permission to backup a database
4096	Permission to create a default
8192	Permission to backup a database transaction log
16384	Permission to create a rule
32768	Permission to backup to a table
65366	Permission to create a user defined function
130944	All privileges applicable to the database

[1542] References

[1543] key MSSQL_Table Element

[1544] Access Type: Read-only

[1545] The Element property references a SQL Server table.

[1546] key MSSQL_DatabaseRole Grantee

[1547] Access Type: Read-only

[1548] The Grantee property references a data bas e role for which the permissions have been defined.

[1549] MSSQL_DatabaseRoleUserDefinedFunctionPermission: MSSQL_Permission

[1550] Association Class

[1551] The MSSQL_DatabaseRoleUserDefinedFunctionPermission class represents the permissions that a database role has for a table. The instances of this class represent only the permissions that have been explicitly granted or denied to the user object. For example, if a database role has permissions to access the user defined function by virtue of being a member of another database role, then there will not be a permission association instance between the role and the user defined function.

[1552] Properties

[1553] boolean Granted

[1554] Access Type: Read/Write

[1555] The Granted property indicates whether the permission has been granted or denied. A value of True indicates that the permission has been granted. A value of False indicates that permission has been denied.

[1556] key uint32 PrivilegeType

[1557] Access Type: Read/Write

[1558] The PrivilegeType property indicates the type of privilege that has been granted or denied.

Value	Description
0	Unknown
1	Permission to query a table
2	Permission to add rows to a table
4	Permission to update rows of a table
8	Permission to delete rows of a table
16	Permission to execute a stored procedure
32	Permission to grant DRI on a table
63	All privileges applicable to the database object
128	Permission to create and own a table
256	Permission to create and own a database
512	Permission to create and own a view
1024	Permission to create and own a stored
	procedure
2048	Permission to backup a database
4096	Permission to create a default
8192	Permission to backup a database transaction log
16384	Permission to create a rule
32768	Permission to backup to a table
65366	Permission to create a user defined function
130944	All privileges applicable to the database

[1559] References

[1560] key MSSQL_UserDefinedFunction Element

[1561] Access Type: Read/Write

[1562] The Element property references a user-defined function.

[1563] key MSSQL_DatabaseRole Grantee

[1564] Access Type: Read/Write

[1565] The Grantee property references a database role for which the permissions have been defined.

[1566] MSSQL_DatabaseRoleViewPermission: MSSQL_Permission

[1567] Association Class

[1568] The MSSQL_DatabaseRoleViewPermission class represents the permissions that a database role has for a view. The instances of this class represent only the permissions that have been explicitly granted or denied to the user object.

[1569] For example, if a database role has permissions to access the view by virtue of being a member of another database role, then there will not be a permission association instance between the role and the view.

[1570] Properties

[1571] string ColumnName

[1572] Access Type: Read/Write

[1573] The ColumnName property specifies the columns within the view for which the permission is specified. If this property is null, then the permission applies to all columns in the view, otherwise it applies only to the columns indicated in this property.

[1574] boolean Granted

[1575] Access Type: Read/Write

[1576] The Granted property indicates whether the permission has been granted or denied. A value of True indicates that the permission has been granted. A value of False indicates that permission has been denied.

[1577] key uint32 PrivilegeType

[1578] Access Type: Read/Write

[1579] The PrivilegeType property indicates the type of privilege that has been granted or denied.

Value	Description
0	Unknown
1	Permission to query a table
2	Permission to add rows to a table
4	Permission to update rows of a table
8	Permission to delete rows of a table
16	Permission to execute a stored procedure
32	Permission to grant DRI on a table
63	All privileges applicable to the database object
128	Permission to create and own a table
256	Permission to create and own a database
512	Permission to create and own a view
1024	Permission to create and own a stored procedure
2048	Permission to backup a database
4096	Permission to create a default
8192	Permission to backup a database transaction log
16384	Permission to create a rule
32768	Permission to backup to a table
65366	Permission to create a user defined function
130944	All privileges applicable to the database

[1580] key MSSQL_View Element

[1581] Access Type: Read-only

[1582] The Element property references a SQL Server view.

[1583] key MSSQL_DatabaseRole Grantee

[1584] Access Type: Read-only

[1585] The Grantee property references a database role for which the permissions have been defined.

[1586] MSSQL_DatabaseRule: MSSQL_Scope

[1587] Association Class

[1588] The MSSQL_DatabaseRule class represents an association between a database and the rules defined within the database.

[1589] References

[1590] key MSSQL_Rule ScopedElement

[1591] Access Type: Read-only

[1592] The ScopedElement property references a rule defined in the database referenced by the ScopingElement property.

[1593] key MSSQL_Database ScopingElement

[1594] Access Type: Read-only

[1595] The ScopingElement property references a SQL Server database.

[1596] MSSQL_DatabaseSetting: MSSQL_Setting

[1597] The MSSQL_DatabaseSetting class represents operational settings for a database.

[1598] Properties

[1599] boolean AssignmentDiag

[1600] Access Type: Read/Write

[1601] The AssignmentDiag property enables SQL-92 standard behavior for NULL in aggregate, data truncation, divide-by-zero, and arithmetic overflow errors.

[1602] boolean AutoClose

[1603] Access Type: Read/Write

[1604] The AutoClose property exposes server behavior for databases not accessed by a user. If TRUE, the database is closed and its resources are freed when no user connection accesses the database. If FALSE, the server maintains the database in an open and ready state regardless of user activity.

[1605] boolean AutoCreateStat

[1606] Access Type: Read/Write

[1607] The AutoCreateStat property exposes Microsoft SQL Server data distribution statistics creation behavior. If TRUE, the optimizer directs automatic creation of supporting data distribution statistics as required. If FALSE, the optimizer does not direct statistics creation.

[1608] boolean AutoShrink

[1609] Access Type: Read/Write

[1610] The AutoShrink property exposes Microsoft SQL Server sizing behavior for operating system files maintaining table and index data. If TRUE, operating system files maintaining table and index data are evaluated for downward resizing when the server periodically checks for unused space. If FALSE, the operating system files storing the database are not evaluated during periodic checks for unused space.

[1611] boolean AutoUpdateStat

[1612] Access Type: Read/Write

[1613] The AutoUpdateStat property exposes Microsoft SQL Server data distribution statistics creation behavior. If TRUE, the optimizer directs automatic rebuild of supporting data distribution statistics as required. If FALSE, the optimizer does not direct statistics rebuild.

[1614] string Caption

[1615] Access Type: Read-only

[1616] A short textual description (one-line string) of the MSSQL_DatabaseSetting object.

[1617] Maximum Length: 64

[1618] boolean ColumnsNullByDefault

[1619] Access Type: Read/Write

[1620] The ColumnsNullByDefault property controls column default value behavior when a table is created in the Microsoft SQL Server database. If TRUE, columns in new tables allow NULL. If FALSE, columns in new tables do not allow NULL.

[1621] boolean CompareNull

[1622] Access Type: Read/Write

[1623] The CompareNull property controls evaluation of NULL for equality. If TRUE, the expression NULLNULL evaluates as NULL. If FALSE, the expression NULLNULL evaluates as TRUE.

[1624] boolean ContactNull

[1625] Access Type: Read/Write

[1626] The ContactNull property specifies NULL value handling for catenation. If TRUE, ANULL, where A is a string, yields NULL. If FALSE, ANULL, where A is a string, yields A.

[1627] boolean CursorCloseOnCommit

[1628] Access Type: Read/Write

[1629] The CursorCloseOnCommit property specifies cursor behavior when modifications made within a transaction are committed or rolled back. If TRUE (the default) Microsoft SQL Server cursors are closed when an action ends a transaction. If FALSE, cursors remain open after a transaction-ending action.

[1630] real32 DataSpaceUsage

[1631] Access Type: Read-only

[1632] The DataSpaceUsage property indicates the physical disk resource used to maintain the data of a database. The value reflects the amount of space in use and reserved for use. The actual data space used by any given table is reported by the DataSpaceUsed property of the Table object. The value represents an amount in megabytes and is accurate to two decimal places.

[1633] Units: Megabytes

[1634] boolean DBOUseOnly

[1635] Access Type: Read/Write

[1636] The DBOUseOnly property toggles access rights to a Microsoft SQL Server database. If TRUE, only users with database ownership privilege can access the database. If FALSE, any authorized user can access the database.

[1637] boolean DefaultCursor

[1638] Access Type: Read/Write

[1639] The DefaultCursor property controls the visibility of cursors created in Transact-SQL batches. If TRUE, cursors declared in a batch are created with local scope. If FALSE, cursors declared in a batch are created with global scope.

[1640] string Description

[1641] Access Type: Read-only

[1642] A textual description of the MSSQL_DatabaseSetting object.

[1643] real32 IndexSpaceUsage

[1644] Access Type: Read-only

[1645] The IndexSpaceUsage returns the number of kilobytes assigned to index storage within all operating system files maintaining indexes for the referenced database.

[1646] Units: Kilobytes

[1647] boolean Offline

[1648] Access Type: Read/Write

[1649] The Offline property controls Microsoft SQL Server database availability. When TRUE, the database is unavailable, or is being made unavailable, for use by authorized users. When FALSE, the database is online, or is being brought online, for use by authorized users.

[1650] boolean QuoteDelimiter

[1651] Access Type: Read/Write

[1652] The QuoteDelimiter property controls Microsoft SQL Server interpretation of identifier strings in statements submitted for execution. When TRUE, identifiers can be delimited by double quotation marks and character literal values must be delimited by single quotation marks. When FALSE, identifiers cannot be quoted and must follow all Transact-SQL rules for identifiers. For example, character literal values can be delimited by either single or double quotation marks.

[1653] boolean ReadOnly

[1654] Access Type: Read/Write

[1655] The ReadOnly property controls the ability to update a Microsoft SQL Server database. If TRUE, data in the database cannot be changed. If FALSE, updates are allowed to data in the database.

[1656] uint32 RecoveryType

[1657] Access Type: Read/Write

[1658] The RecoveryType property specifies the type of recovery model that a database will use. Simple is the default setting for SQL Server Desktop Edition and the data engine, and Full is the default for all other editions.

Value	Description	Explanation
0	Simple	The database can be recovered only to the
		last full database backup or last differential
		backup.
1	Bulk Logged	Logging for all SELECT INTO, CREATE
		INDEX, and bulk loading data operations is
		minimal and therefore requires less log space.
		In exchange for better performance and less
		log space usage, the risk of exposure to loss is
		greater than with full recovery.
2	Full	Database backups and transaction log
		backups are used to provide full
		recoverability from media failure. All
		operations, including bulk operations such as
		SELECT INTO, CREATE INDEX, and bulk
		loading data, are fully logged.
3	Unknown	The recovery type is not known.

[1659] boolean RecursiveTriggers

[1660] Access Type: Read/Write

[1661] The RecursiveTriggers property controls nested call behavior for Microsoft SQL Server triggers. When TRUE, a trigger may fire more than once when statement execution directs more than a single trigger execution. When FALSE, a trigger will execute only once regardless of the actions of itself or other triggers enabled on other tables.

[1662] boolean SelectIntoBulkCopy

[1663] Access Type: Read/Write

[1664] The SelectIntoBulkCopy property enables non-logged operation on a Microsoft SQL Server database. If TRUE, non-logged operations are allowed. If FALSE, non-logged operations are not allowed.

[1665] key string SettingID

[1666] Access Type: Read-only

[1667] The identifier by which the MSSQL_DatabaseSetting object is known.

[1668] Maximum Length: 256

[1669] booleanSingleUser

[1670] Access Type: Read/Write

[1671] The SingleUser property exposes one method of constraining user access to a Microsoft SQL Server database. If TRUE, only one user can access the database at any one time. If FALSE, multiple users can access the database at one time.

[1672] key string SQLServerName

[1673] Access Type: Read-only

[1674] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1675] Maximum Length: 128

[1676] boolean TornPageDetection

[1677] Access Type: Read/Write

[1678] The TornPageDetection property enables Microsoft SQL Server logic-enhancing data security in the event of certain types of system failure. If TRUE, SQL Server marks units of a database page prior to attempting a write and checks page marking on every read. If FALSE, database pages are not marked or evaluated.

[1679] boolean TruncateLogOnCheckpoint

[1680] Access Type: Read/Write

[1681] The TruncateLogOnCheckpoint property configures automatic transaction log maintenance activity. If TRUE, SQL Server removes log entries referencing committed transactions when activity on the database forces a dirty page write. If FALSE, the forced dirty page writes have no effect on the database transaction log.

[1682] Associations

[1683] MSSQL_DatabaseSetting is associated to MSSQL_Database as the Setting property of the MSSQL_DatabaseDatabaseSetting association.

[1684] MSSQL_DatabaseStoredProcedure: MSSQL_Scope

[1685] Association Class

[1686] The MSSQL_DatabaseStoredProcedure class represents an association between the database and a stored procedure defined within the database.

[1687] References

[1688] key MSSQL_StoredProcedure ScopedElement

[1689] Access Type: Read-only

[1690] The ScopedElement property references a stored procedure defined within the database referenced by the ScopingElement property.

[1691] key MSSQL_Database ScopingElement

[1692] Access Type: Read-only

[1693] The ScopingElement property references a SQL Server database.

[1694] MSSQL_DatabaseTable: CIM_Component

[1695] Association Class

[1696] The MSSQL_DatabaseTable class associates a database to all the tables contained in the database.

[1697] References

[1698] key MSSQL_Database GroupComponent

[1699] Access Type: Read-only

[1700] The parent element in the association

[1701] key MSSQL_Table PartComponent

[1702] Access Type: Read-only

[1703] The child element in the association

[1704] MSSQL_DatabaseTransactionLog: CIM_Dependency

[1705] Association Class

[1706] The MSSQL_DatabaseTransactionLog class represents an association between the database and the transaction log for the database.

[1707] References

[1708] key MSSQL_TransactionLog Antecedent

[1709] Access Type: Read-only

[1710] Antecedent represents the independent object in this association.

[1711] key MSSQL_Database Dependent

[1712] Access Type: Read-only

[1713] Dependent represents the object dependent on the Antecedent.

[1714] MSSQL_DatabaseUser: MSSQL_Scope

[1715] Association Class

[1716] The MSSQL_DatabaseUser class represents an association between a database and a user defined for the database.

[1717] References

[1718] key MSSQL_User ScopedElement

[1719] Access Type: Read-only

[1720] The ScopedElement property references a user defined within the database referenced by the ScopingElement property.

[1721] key MSSQL_Database ScopingElement

[1722] Access Type: Read-only

[1723] The ScopingElement property references a database in SQL Server.

[1724] MSSQL_DatabaseUserDefinedFunction MSSQL_Scope

[1725] Association Class

[1726] The MSSQL_DatabaseUserDefinedFunction class represents an association between a database and a user-defined function defined within the database.

[1727] References

[1728] key MSSQL_UserDefinedFunction ScopedElement

[1729] Access Type: Read-only

[1730] The ScopedElement property references a user-defined function defined within the database referenced by the ScopingElement property.

[1731] key MSSQL_Database ScopingElement

[1732] Access Type: Read-only

[1733] The ScopingElement property references a database in SQL Server.

[1734] MSSQL_DatabaseView: CIM_Component

[1735] Association Class

[1736] The MSSQL_DatabaseView class associates a database to the view contained within the database.

[1737] References

[1738] key MSSQL_Database GroupComponent

[1739] Access Type: Read-only

[1740] The parent element in the association

[1741] key MSSQL_View PartComponent

[1742] Access Type: Read-only

[1743] The child element in the association

[1744] MSSQL_Datatype: MSSQL_DBMSObject

[1745] Abstract Class

[1746] The MSSQL_Datatype class represents all the datatypes defined in a SQL Server installation. This includes both the user-defined datatypes, as well as the system-defined datatypes.

[1747] Properties

[1748] boolean AllowIdentity

[1749] Access Type: Read-only

[1750] The AllowIdentity property indicates the ability of a data type to participate in a column defined with the identity property. The SQL Server identity property is defined for data types that can accept numeric values. A column defined with the identity property is defined with a starting value and a step value. SQL Server generates values for the column by querying the last applicable value and adding the step value.

[1751] boolean AllowNulls

[1752] Access Type: Read-only

[1753] The AllowNulls property indicates whether the data type has the ability to accept NULL as a value.

[1754] string Caption

[1755] Access Type: Read-only

[1756] The Caption property is a short textual description (one-line string) of the object.

[1757] Maximum Length: 64

[1758] key string DatabaseName

[1759] Access Type: Read-only

[1760] The DatabaseName property indicates the name of the database that the object is a part of.

[1761] Maximum Length: 128

[1762] string Description

[1763] Access Type: Read-only

[1764] The Description property provides a textual description of the object.

[1765] datetime InstallDate

[1766] Access Type: Read-only

[1767] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1768] key string Name

[1769] Access Type: Read-only

[1770] The Name property defines the label by which the object is known.

[1771] key string SQLServerName

[1772] Access Type: Read-only

[1773] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1774] Maximum Length: 128

[1775] string Status

[1776] Access Type: Read-only

[1777] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1778] Values are: OK, Error, Degraded, Unknown,Pred Fail, Starting, Stopping, Service

[1779] Maximum Length: 10

[1780] Associations

[1781] MSSQL_Datatype is associated to MSSQL_Database as the ScopedElement property of the MSSQL_DatabaseDatatype association.

[1782] MSSQL_Datatype is associated to MSSQL_Column as the Antecedent property of the MSSQL_ColumnDatatype association.

[1783] MSSQL_DBMSObject: CIM_LogicalElement

[1784] Abstract Class

[1785] The MSSQL_DBMSObject class represents objects in a database system. These objects include storage objects such as databases, tables, keys and constraints.

[1786] Properties

[1787] string Caption

[1788] Access Type: Read-only

[1789] The Caption property is a short textual description (one-line string) of the object.

[1790] Maximum Length: 64

[1791] string Description

[1792] Access Type: Read-only

[1793] The Description property provides a textual description of the object.

[1794] datetime InstallDate

[1795] Access Type: Read-only

[1796] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1797] string Name

[1798] Access Type: Read-only

[1799] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[1800] string Status

[1801] Access Type: Read-only

[1802] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1803] Values are: OK,Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1804] Maximum Length: 10

[1805] Associations

[1806] MSSQL_DBMSObject is associated to MSSQL_DBMSUserObject as the Element property of the MSSQL_Permission association.

[1807] MSSQL_DBMSObject is associated to MSSQL_User as the Dependent property of the MSSQL_DBMSObjectOwner association.

[1808] MSSQL_DBMSObjectOwner: CIM_Dependency

[1809] Association Class

[1810] The MSSQL_DBMSObjectOwner class represents an association between a SQL Server m database object and the user who owns the object.

[1811] References

[1812] key MSSQL_User Antecedent

[1813] Access Type: Read-only

[1814] The Antecedent property references the user who owns the database object referenced by the Dependent property.

[1815] key MSSQL_DBMSObject Dependent

[1816] Access Type: Read-only

[1817] The Dependent property references a SQL Server database object.

[1818] MSSQL_Default: MSSQL_DBMSObject

[1819] The MSSQL_Default class represents the attributes of a single Microsoft SQL Server default. SQL Server defaults provide data to columns and user-defined data types when no other data is available on an INSERT statement execution.

[1820] Properties

[1821] string Caption

[1822] Access Type: Read-only

[1823] The Caption property is a short textual description (one-line string) of the object.

[1824] Maximum Length: 64

[1825] datetime CreateDate

[1826] Access Type: Read-only

[1827] The CreateDate property indicates the time and date on which the default was created. Note that creation date may be different from the install date in cases where the object is created in one place and then installed elsewhere.

[1828] key string DatabaseName

[1829] Access Type: Read-only

[1830] The DatabaseName property indicates the name of the database that the object is a part of.

[1831] Maximum Length: 128

[1832] string Description

[1833] Access Type: Read-only

[1834] The Description property provides a textual description of the object.

[1835] datetime InstallDate

[1836] Access Type: Read-only

[1837] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1838] key string Name

[1839] Access Type: Read-only

[1840] The Name property defines the label by which the object is known.

[1841] key string SQLServerName

[1842] Access Type: Read-only

[1843] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1844] Maximum Length: 128

[1845] string Status

[1846] Access Type: Read-only

[1847] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1848] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1849] Maximum Length: 10

[1850] string Text

[1851] Access Type: Read/Write

[1852] The Text property indicates the Transact-SQL script that defines the object. Note that there is a special requirement for the name of the object is specified in the CREATE statement. The name of the object has to be in the form that includes the name of the owner. For example, in order to create an object named Some Object, one would need to specify it as dbo.Some Object.

[1853] Methods

[1854] The MSSQL_Default class supports the following methods:

Method Name	Description
Rename	The Rename method is used to rename a default
	instance.

[1855] Associations

[1856] MSSQL_Default is associated to MSSQL_Database as the ScopedElement property of the MSSQL_DatabaseDefault association.

[1857] MSSQL_Default is associated to MSSQL_Column as the Antecedent property of the MSSQL_ColumnDefault association.

[1858] MSSQL_Default is associated to MSSQLUserDatatype as the Antecedent property of the MSSQL_UserDatatypeDefault association.

[1859] MSSQL_DRIDefault: MSSQL_DBMSObject

[1860] The MSSQL_DRIDefault class represents the properties of a Microsoft SQL Server column DEFAULT constraint.

[1861] Properties

[1862] string Caption

[1863] Access Type: Read-only

[1864] The Caption property is a short textual description (one-line string) of the object.

[1865] Maximum Length: 64

[1866] key string ColumnName

[1867] Access Type: Read-only

[1868] The ColumnName property indicates the name of the column that the DRI default is defined in.

[1869] Maximum Length: 128

[1870] key string DatabaseName

[1871] Access Type: Read-only

[1872] The DatabaseName property indicates the name of the database that the object is a part of.

[1873] Maximum Length: 128

[1874] string Description

[1875] Access Type: Read-only

[1876] The Description property provides a textual description of the object.

[1877] datetime InstallDate

[1878] Access Type: Read-only

[1879] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1880] key string Name

[1881] Access Type: Read-only

[1882] The Name property defines the label by which the object is known.

[1883] key string SQLServerName

[1884] Access Type: Read-only

[1885] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1886] Maximum Length: 128

[1887] string Status

[1888] Access Type: Read-only

[1889] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1890] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1891] Maximum Length: 10

[1892] key string TableName

[1893] Access Type: Read-only

[1894] The TableName property indicates the name of the table that the DRI default is defined in.

[1895] Maximum Length: 128

[1896] string Text

[1897] Access Type: Read/Write

[1898] The Text property indicates the Transact-SQL or other script that defines the object. Note that there is a special requirement for the name of the object is specified in the CREATE statement. The name of the object has to be in the form that includes the name of the owner. For example, in order to create an object named Some Object, one would need to specify it as dbo.Some Object. Associations

[1899] MSSQL_DRIDefault is associated to MSSQL_Column as the Antecedent property of the MSSQL_ColumnDRIDefault association.

[1900] MSSQL_ErrorLog: CIM_LogicalElement

[1901] The MSSQL_ErrorLog class represents the SQL Service error logs.

[1902] Properties

[1903] key string ArchiveID

[1904] Access Type: Read-only

[1905] ArchiveNumber identifies the number of the log. The active log has number 0.

[1906] Maximum Length: 128

[1907] string Caption

[1908] Access Type: Read-only

[1909] The Caption property is a short textual description (one-line string) of the object.

[1910] Maximum Length: 64

[1911] string Description

[1912] Access Type: Read-only

[1913] The Description property provides a textual description of the object.

[1914] datetime InstallDate

[1915] Access Type: Read-only

[1916] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1917] datetime LastModified

[1918] Access Type: Read-only

[1919] LastModified indicates the time and date the log was last modified.

[1920] key string Name

[1921] Access Type: Read-only

[1922] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[1923] string Status

[1924] Access Type: Read-only

[1925] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1926] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1927] Maximum Length: 10

[1928] Associations

[1929] MSSQL_ErrorLog is associated to MSSQL_SQLServer as the Antecedent property of the MSSQL_SQLServerErrorLog association.

[1930] MSSQL_ErrorLog is associated to MSSQL ErrorLogEntry as the GroupComponent property of the MSSQL_ErrorLogErrorLogEntry association.

[1931] MSSQL_ErrorLog is associated to CIM_DataFile as the Dependent property of the MSSQL_ErrorLogDataFile association.

[1932] MSSQL ErrorLogDataFile: CIM_Dependency

[1933] Association Class

[1934] The MSSQL_ErrorLogDataFile class represents an association between a SQL Server error log, and the operating system file used to store the error log.

[1935] References

[1936] key CIM_DataFile Antecedent

[1937] Access Type: Read-only

[1938] The Antecedent property references an operating system file used to store the error log referenced by the Dependent property.

[1939] key MSSQL_ErrorLog Dependent

[1940] Access Type: Read-only

[1941] The Dependent property references a SQL Server error log.

[1942] MSSQL_ErrorLogEntry: CIM_LogicalElement

[1943] The MSSQL_ErrorLogEntry class represents the entries in a SQL Service error log.

[1944] Properties

[1945] key string ArchiveID

[1946] Access Type: Read-only

[1947] The ArchiveNumber property identifies the archive number of the log the entry is stored in. The active log has number 0.

[1948] Maximum Length: 128

[1949] string Caption

[1950] Access Type: Read-only

[1951] The Caption property is a short textual description (one-line string) of the object.

[1952] Maximum Length: 64

[1953] string Description

[1954] Access Type: Read-only

[1955] The Description property provides a textual description of the object.

[1956] key string EntryID

[1957] Access Type: Read-only

[1958] EntryNumber identifies the number of the entry within a log. Each entry in a log is successively numbered.

[1959] Maximum Length: 128

[1960] datetime InstallDate

[1961] Access Type: Read-only

[1962] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[1963] string Name

[1964] Access Type: Read-only

[1965] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[1966] key string SQLServerName

[1967] Access Type: Read-only

[1968] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[1969] Maximum Length: 128

[1970] string Status

[1971] Access Type: Read-only

[1972] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[1973] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[1974] Maximum Length: 10

[1975] string Text

[1976] Access Type: Read-only

[1977] Text is the descriptive text of the error log entry.

[1978] Associations

[1979] MSSQL_ErrorLogEntry is associated to MSSQL_ErrorLog as the PartComponent property of the MSSQL_ErrorLogErrorLogEntry association.

[1980] MSSQL_ErrorLogErrorLogEntry: CIM_Component

[1981] Association Class

[1982] The MSSQL_ErrorLogErrorLogEntry class represents an association between an error log and an entry in the error log.

[1983] References

[1984] key MSSQL_ErrorLog GroupComponent

[1985] Access Type: Read-only

[1986] The GroupComponent property references a SQL Server error log.

[1987] key MSSQL_ErrorLogEntry PartComponent

[1988] Access Type: Read-only

[1989] The PartComponent property references an entry in the error log referenced by the GroupComponent property.

[1990] MSSQL_Extends

[1991] Abstract Class

[1992] Association Class

[1993] The MSSQL_Extends class is an abstract association class. It associates a class with another class that extends the former class by defining some new properties and methods.

[1994] References

[1995] CIM_ManagedSystemElement ExtendedElement

[1996] Access Type: Read-only

[1997] The ExtendedElement property references a managed system element that is being extended.

[1998] MSSQL_Extension Extension

[1999] Access Type: Read-only

[2000] The Extension property references a extension to the managed system element referenced by the ExtendedElement property.

[2001] MSSQL_Extension

[2002] Abstract Class

[2003] The MSSQL_Extension class represents extensions made via associations to a managed system element. Extensions are made via associations when it is not possible or desirable to extend a class by subclassing.

[2004] Associations

[2005] MSSQL_Extension is associated to CIM_ManagedSystemElement as the Extension property of the MSSQL_Extends association.

[2006] MSSQL_FileGroup: CIM_LogicalElement

[2007] The MSSQL_FileGroup class exposes the attributes of a Microsoft SQL Server filegroup.

[2008] Properties

[2009] string Caption

[2010] Access Type: Read-only

[2011] The Caption property is a short textual description (one-line string) of the object.

[2012] Maximum Length: 64

[2013] key string DatabaseName

[2014] Access Type: Read-only

[2015] The DatabaseName property indicates the name of the database that the object is a part of.

[2016] Maximum Length: 128

[2017] boolean Default

[2018] Access Type: Read/Write

[2019] The Default property indicates the filegroup used when no filegroup is specified as part of table or index creation. If TRUE, the referenced filegroup is used to implement table or index data storage when a table or index is created and no filegroup is specified. If FALSE, the referenced filegroup is not used as the default in table and index creation. The filegroup may be specified by name to direct creation.

[2020] string Description

[2021] Access Type: Read-only

[2022] The Description property provides a textual description of the object.

[2023] datetime InstallDate

[2024] Access Type: Read-only

[2025] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[2026] key string Name

[2027] Access Type: Read-only

[2028] The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

[2029] boolean ReadOnly

[2030] Access Type: Read/Write

[2031] The ReadOnly property controls the ability to update a Microsoft SQL Server database or database filegroup. If TRUE, data in the database or database filegroup cannot be changed. If FALSE, updates are allowed to data in the database or database filegroup.

[2032] sint32 Size

[2033] Access Type: Read-only

[2034] The Size property exposes the total size, in megabytes, of the filegroup.

[2035] key string SQLServerName

[2036] Access Type: Read-only

[2037] The SQLServerName property indicates the name of the SQL Server installation that the object is a part of.

[2038] Maximum Length: 128

[2039] string Status

[2040] Access Type: Read-only

[2041] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[2042] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[2043] Maximum Length: 10

[2044] uint32 Type

[2045] This property indicates the type of the file group. The file group can be of three types. It is either a user defined file group, a primary file group, or a filegroup defined on files maintained on read-only media. When a database is created, it is created on exactly one filegroup named PRIMARY. This is the primary file group. After database creation, filegroups can be added to the database. These are the user defined file groups.

Value	Description
0	User Defined
8	On Read-Only Media
16	Primary

[2046] Methods

[2047] The MSSQL_FileGroup class supports the following methods:

Method Name	Description
CheckFilegroup	The CheckFilegroup method scans and tests
	the integrity of database pages maintained
	in operating system files implementing the
	referenced filegroup.
CheckFilegroupDataOnly	The CheckFilegroupDataOnly method scans
	and tests the integrity of database pages
	that are used to maintain table data in
	the operating system files implementing
	the referenced filegroup.
EnumStoredObiects	The EnumStoredObjects method enumerates
	the names of the indexes, tables and
	statistical mechanisms stored in the
	filegroup.

[2048] Associations

[2049] MSSQL_FileGroup is associated to MSSQL_Database as the Antecedent property of the MSSQL_DatabaseFileGroup association.

[2050] MSSQL_FileGroup is associated to MSSQL_Table as the Antecedent property of the MSSQL_TableFileGroup association.

[2051] MSSQL_FileGroup is associated to MSSQL_Table as the Antecedent property of the MSSQL_TableTextFileGroup association.

[2052] MSSQL_FileGroup is associated to MSSQL_Index as the Antecedent property of the MSSQL_indexFileGroup association.

[2053] MSSQL_FileGroup is associated to MSSQL_CandidateKey as the

[2054] Antecedent property of the MSSQL_KeyFileGroup association.

[2055] MSSQL_FileGroup is associated to MSSQL_DatabaseFile as the GroupComponent property of the MSSQL_FileGroupDatabaseFile association.

[2056] MSSQL_FileGroupDatabaseFile: CIM_Component Association Class

[2057] The MSSQL_FileGroupDatabaseFile class associates a database file group to the operating system files that are part of the group.

[2058] References

[2059] key MSSQL_FileGroup GroupComponent

[2060] Access Type: Read-only

[2061] The parent element in the association

[2062] key MSSQL_DatabaseFile PartComponent

[2063] Access Type: Read-only

[2064] The child element in the association

[2065] MSSQL_ForeignKey: MSSQL_Key

[2066] The MSSQL_ForeignKey class represents the foreign keys defined for a SQL Server database table.

[2067] Properties

[2068] string Caption

[2069] Access Type: Read-only

[2070] The Caption property is a short textual description (one-line string) of the object.

[2071] Maximum Length: 64

[2072] boolean Checked

[2073] Access Type: Read/Write

[2074] The Checked property enables or disables foreign constraint evaluation for an existing foreign key constraint. If True, an attempt is made to enforce a foreign key constraint when rows are added to the table on which the constraint is defined. If False, no attempt is made to enforce the foreign constraint when rows are added to the table on which the constraint is defined.

[2075] key string DatabaseName

[2076] Access Type: Read-only

[2077] The DatabaseName property indicates the name of the database that the key is a part of.

[2078] Maximum Length: 128

[2079] string Description

[2080] Access Type: Read-only

[2081] The Description property provides a textual description of the object.

[2082] boolean ExcludeReplication

[2083] Access Type: Read-only

[2084] The ExcludeReplication property controls foreign key constraint enforcement when replicated data is inserted into the columns on which the foreign key constraint is defined

[2085] datetime InstallDate

[2086] Access Type: Read-only

[2087] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[2088] key string Name

[2089] Access Type: Read-only

[2090] The Name property defines the label by which the object is known. The name of a key is unique within a database.

[2091] key string SQLServerName

[2092] Access Type: Read-only

[2093] The SQLServerName property indicates the name of the SQL Server installation that the key is a part of.

[2094] Maximum Length: 128

[2095] string Status

[2096] Access Type: Read-only

[2097] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[2098] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[2099] Maximum Length: 10

[2100] key string TableName

[2101] Access Type: Read-only

[2102] The TableName property indicates the name of the table that the key is defined in.

[2103] Maximum Length: 128

[2104] Methods

[2105] The MSSQL_ForeignKey class supports the following methods:

Method Name	Description
Create	The Create method is used to create a new foreign key.
Rename	The Rename method is used to rename the foreign key
	instance.

[2106] Associations

[2107] MSSQL_ForeignKey is associated to MSSQL_CandidateKey as the Dependent property of the MSSQL_ReferencedKey association.

[2108] MSSQL_ForeignKey is associated to MSSQL_Table as the Dependent property of the MSSQL_ReferencedTable association.

[2109] MSSQL_FullTextCatalog: CIM_LogicalElement

[2110] The MSSQL_FullTextCatalog class represents a single Microsoft Search persistent data store. Microsoft Search enables full-text queries on data maintained by Microsoft SQL Server. The service both builds the indexes providing full-text query capability and participates in query resolution by providing result data during a full-text query. Index data is maintained within a full-text catalog.

[2111] Properties

[2112] string Caption

[2113] Access Type: Read-only

[2114] The Caption property is a short textual description (one-line string) of the object.

[2115] Maximum Length: 64

[2116] key string DatabaseName

[2117] Access Type: Read-only

[2118] The DatabaseName property indicates the name of the database that the full text catalog is a part of.

[2119] Maximum Length: 128

[2120] string Description

[2121] Access Type: Read-only

[2122] The Description property provides a textual description of the object.

[2123] uint32 ErrorLogSize

[2124] Access Type: Read-only

[2125] The ErrorLogSize property returns the size, in bytes, of a Microsoft Search full-text catalog error log.

[2126] Units: Bytes

[2127] boolean FullTextIndexedTables

[2128] Access Type: Read-only

[2129] The FullTextIndexedTables property reports Microsoft Search full-text catalog use. When TRUE, at least one table uses the full-text catalog for index data storage. When FALSE, the full-text catalog is not currently used for index data storage.

[2130] uint32 FullTextIndex

[2131] Access Type: Read-only

[2132] The FullTextIndex property returns the size, in megabytes, of the full-text catalog.

[2133] Units: Megabytes

[2134] datetime InstallDate

[2135] Access Type: Read-only

[2136] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[2137] uint32 ItemCount

[2138] Access Type: Read-only

[2139] The ItemCount property returns the number of entries contained in a Microsoft Search full-text catalog. For each table indexed in the full-text catalog, an entry is made for the table and an entry is made for each row in the table.

[2140] key string Name

[2141] Access Type: Read/Write

[2142] The Name property is a label used to uniquely identify the object.

[2143] uint32 PopulateCompletionAge

[2144] Access Type: Read-only

[2145] The PopulateCompletionAge property returns the number of seconds between the time of the most recent, successful Microsoft Search full-text catalog population and a system-defined date and time. A value of zero represents the base date and time, 12:00:00 AM, Jan. 1, 1990.

[2146] Units: Seconds

[2147] datetime PopulateCompletionDate

[2148] Access Type: Read-only

[2149] The PopulateCompletionDate property returns the most recent date land time at which an update was made to the full-text catalog.

[2150] uint32 PopulateStatus

[2151] Access Type: Read-only

[2152] The PopulateStatus property returns the population state of a Microsoft Search full-text catalog. The property can have one of the following values: IdleNo action is being performed against the referenced full-text catalog. In ProgressFull index population is in progress for the referenced full-text catalog. PausedLack of available resource, such as disk space, has caused an interruption. ThrottledMicrosoft Search service has paused the referenced full-text index population. RecoveringInterrupted population on the referenced full-text catalog is resuming. ShutdownReferenced full-text catalog is being deleted or is otherwise not accessible. IncrementalIncremental index population is in progress for the referenced full-text catalog. Updating IndexReferenced full-text catalog is being assembled by the Microsoft Search service. Assemblage is the final step in full-text catalog population.

[2153] Values are: Idle, In Progress, Paused, Throttled, Recovering, Shutdown, Incremental, Updating Index

[2154] string RootPath

[2155] Access Type: Read/Write

[2156] The RootPath property specifies an operating system directory used as the primary path for Microsoft Search full-text catalog storage. If the RootPath property is an empty string when creating a Microsoft Search full-text catalog, the default data path, set for the Microsoft Search service, is used.

[2157] key string SQLServerName

[2158] Access Type: Read-only

[2159] The SQLServerName property indicates the name of the SQL Server installation that the full-text catalog is a part of.

[2160] Maximum Length: 128

[2161] string Status

[2162] Access Type: Read-only

[2163] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[2164] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[2165] Maximum Length: 10

[2166] uint32 UniqueKeyCount

[2167] Access Type: Read-only

[2168] The UniqueKeyCount property returns an approximate number of words uniquely addressable in a Microsoft Search full-text catalog.

[2169] Methods

[2170] The MSSQL_FullTextCatalog class supports the following methods:

Method Name	Description
Rebuild	The Rebuild method re-creates the Microsoft
	Search full-text catalog.
StartFullTextPopulation	The StartFullTextPopulation method starts
	Microsoft Search full-text table population.
StopFullTextPopulation	The StopFullTextPopulation method stops full-
	text population.

[2171] Associations

[2172] MSSQL_FullTextCatalog is associated to MSSQL_Database as the Antecedent property of the MSSQL_DatabaseFullTextCatalog association.

[2173] MSSQL_FullTextCatalogService: CIM_Service

[2174] The MSSQL_FullTextCatalogService class represents the Microsoft Search full-text indexing service. The Microsoft Search full-text indexing service enables full-text queries on data maintained by SQL Server. Microsoft Search both builds the indexes providing full-text query capability and participates in query resolution by providing result data during a full-text query.

[2175] Properties

[2176] string Caption

[2177] Access Type: Read-only

[2178] The Caption property is a short textual description (one-line string) of the object.

[2179] Maximum Length: 64

[2180] sint32 ConnectTimeout

[2181] Access Type: Read/Write

[2182] The ConnectTimeout property specifies a time interval used by the Microsoft Search service when attempting a connection to a Microsoft SQL Server installation enabled for full-text search.

[2183] string CreationClassName

[2184] Access Type: Read-only

[2185] CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

[2186] string DefaultPath

[2187] Access Type: Read-only

[2188] The DefaultPath property returns the operating system path naming a directory used as a root for Microsoft Search full-text catalog implementation if no user-specified path is supplied during full-text catalog creation.

[2189] string Description

[2190] Access Type: Read-only

[2191] The Description property provides a textual description of the object.

[2192] datetime InstallDate

[2193] Access Type: Read-only

[2194] The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

[2195] boolean IsFullTextInstalled

[2196] Access Type: Read-only

[2197] The IsFullTextInstalled property returns True when the Microsoft Search service has been successfully installed on a server running Microsoft SQL Server.

[2198] key string Name

[2199] Access Type: Read-only

[2200] The Name property uniquely identifies the service and provides an indication of the functionality that is managed. This functionality is described in more detail in the object's Description property. The default value of this property is MSSearch

[2201] sint32 ResourceUsage

[2202] Access Type: Read/Write

[2203] The ResourceUsage property specifies a relative operating system execution priority setting for the Microsoft Search service. Use the ResourceUsage property to raise or lower execution priority for a running Microsoft Search service. By default, ResourceUsage is 3, interpreted as normal priority for the service. Set ResourceUsage to 2 or 1 to lower the execution priority for the Microsoft Search service. Set ResourceUsage to 4 or 5 to raise the execution priority. Note that a value of 5 represents dedicated priority for the Microsoft Search service. Setting the ResourceUsage property to a value higher than 3 can have unintended consequences and should be considered only after evaluating the possible effects on other services running on the computer.

[2204] uints32 ServiceStatus

[2205] Access Type: Read-only

[2206] The ServiceStatus property reports the execution state of the service.

Value	Description
0	Unknown
1	Running
2	Paused
3	Stopped
4	Starting
5	Stopping
6	Pausing

[2207] boolean Started

[2208] Access Type: Read-only

[2209] Started is a boolean indicating whether the service has been started (TRUE), or stopped (FALSE).

[2210] string StartMode

[2211] Access Type: Read-only

[2212] StartMode is a string value indicating whether the service is automatically started by a operating system, or only started upon request.

[2213] Values are: Automatic, Manual

[2214] string Status

[2215] Access Type: Read-only

[2216] The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are OK, Degraded and Pred Fail. Pred Fail indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are Error, Starting, Stopping and Service. The latter, Service, could apply during mirror re-silvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither OK nor in one of the other states.

[2217] Values are: OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service

[2218] Maximum Length: 10

[2219] string SystemCreationClassName

[2220] Access Type: Read-only