The Object details options allows choosing the specific objects, object types, and object details that for including in the documentation. To access the Object details options:
The Object filter provides great flexibility and control over exactly which objects in the database are documented. See the Object filter page for more information about using the Object filter
To select the specific object details, select the object type you are interested in and then select the Options tab, on the right side of the screen
The following tables provide information about the specific details that can be included for each object type, including the specific information that will be documented for each object detail option
| Properties | A list of datatype properties, including name, schema, owner, storage type, maximum length, precision, scale, allow NULLs status, rule, default value, ID and IS Assembly type status |
| Columns | The following datatype columns will be documented: Name, Parent and Description |
| Properties | A list of default’s properties, including name, schema, owner, creation date, value and ID |
| Columns | The following defaults columns will be documented: name, parent, description, data type and max length |
| Properties | A list of Fulltext catalogs properties, including owner, Is default status, Is accent sensitive status, File group, Path and ID |
| Permissions | Select this check box to include the permissions of Fulltext catalogs to documenting |
| Properties | A list of function properties, including schema, owner, creation date, type, Is schema bound status, Is deterministic status, encryption status, Implementation type and ID |
| Parameters | A list of function parameters, including description, data type, and max length |
| Recordset | A list of functions recordsets, including name, description, datatype and max length |
| DB permissions | Select this check box to include the database permissions of function to documenting |
| Options section | A list of the values for each function
options EXAMPLE: QUOTED_INDENTIFIER, ANSI_NULLS |
| Properties | A list of procedure properties, including schema, owner, creation date, encryption status, Implementation type and ID |
| Parameters | A list of procedure parameters, including description, data type, max length and type |
| DB permissions | Select this check box to include the database permissions of procedure to documenting |
| Options section | A list of the values for each function
options |
| Properties | A list of role properties, including name, owner and type |
| Permissions | A list of permissions, including object and Select, Insert, Update, Delete, Exectue and DRI status |
| Users | A list of the users of Role |
| DB permissions | Select this check box to include the database permissions of Role to documenting |
| Properties | A list of rules properties, including name, schema, owner, creation date, expression and ID |
| Columns | The following columns of the rule will be documented: name, parent, description, data type and length |
| Properties | A list of tables properties, including schema, owner, replication status, creation date, ID, location, data size, index size and number of rows |
| Checks | Check constraint details including the name and expression |
| Collations | The collation details of the table |
| Columns | The list of columns of the table, including name, description, data type, max length, Nullable status, defaults and IsGUID status |
| Creation Options | The list of creation options details of the table, including the name and value |
| Identity | Identity details of the table, including name, seed, and increment and replication status |
| Indexes | The index details of the table, including index name, and primary and unique status |
| Options section | The options details of the table, including printable status, table lock on bukl load status, insert row lock status, text in row and large value types out of row |
| Permissions | The permissions details of the table, including user/role, alter, control, select, insert, update, delete, DRI, take ownership, view definition and columns |
| Relationships | The relationship details of the table including table name, foreign key, primary key or unique constraint for both, the referenced and the referencing tables |
| Statistics | The statistics details of the table including page statistics, extent and row statistics |
| Triggers | Select this check box to include the triggers details of the Table to documenting. The triggers will appear in the Contents tab and clicking on any trigger will display information about it |
| Properties | A list of triggers properties, including schema, owner, creation date, encryption status, implementation type and ID |
| Options Section | A list of the triggers creation options including name and value |
| Type | The type of the trigger including instead of, insert, update and delete |
| Properties | The properties of user, including the name, login, id and value |
| Objects | A list of objects of the user, including the name and the type of object |
| Permissions | A list of permissions of the user, including object, select, insert, update, delete, execute and DRI status |
| Roles | Select this check box to include the roles of user to documenting |
| DB permissions | Select this check box to include the database permissions of user to documenting |
| Properties | A list of views properties, including schema, owner, creation date, Is Schema Bound status, encryption status and ID |
| Options section | A list of the view creation options including the name and value |
| Permissions | The permissions details of the view, including user/role, alter, control, select, insert, update, delete, DRI, take ownership, view definition and columns |
| Indexes | A list of indexes of the view, including name, description and the size in KB |
| Statistics | Select this check box to include the statistics of the View to documenting |
| Triggers | Select this check box to include the triggers of the View to documenting. The triggers will appear in the Contents tab and clicking on any trigger will display information about it |
| Columns | A list of the columns of the view, including name, description, data type and max length |
| Properties | A list of the assembly properties, including owner, creation date, CLR name, Is Visible status, permissions set and ID |
| Permissions | Select this check box to include the permissions of Assemblies to documenting |
| Properties | A list of the asymmetric key’s properties, including name, owner, algorithm, key length, ID and key encryption type |
| Permissions | Select this check box to include the permissions of Asymmetric Keys to documenting |
| Properties | A list of the certificate properties, including name, owner, Is Active For Begin Dialog status, ID, subject, start date, expiry date and key encryption type |
| Permissions | Select this check box to include the permissions of Certificates to documenting |
| Properties | A list of the contract properties, including name, owner, and ID |
| Permissions | Select this check box to include the permissions of the Contracts to documenting |
| Properties | A list of the DDL Trigger properties, including encryption status, current status ID and implementation type |
| Options section | A list of the DDL triggers creation options including the name and value |
| Properties | A list of the event notifiaction properties, including name, owner, creation date, service, broker instance, FAN_IN status and ID |
| Properties | A list of thefulltext stoplist properties, including the name and value |
| Permissions | Select this check box to include the permissions of the Fulltext Stoplists to documenting |
| Properties | A list of the message type properties, including name, validation, XML schema collection, owner and ID |
| Permissions | Select this check box to include the permissions of Message Types to documenting |
| Properties | A list of partition function properties, including creation date, range, parameter type, collation and ID |
| Properties | A list of partition schemes properties, including name and value |
| Properties | A list of queue properties, including name, creation date, schema, owner, status, retention, activation, procedure, execute as, max queue readers, file group and ID |
| Permissions | Select this check box to include the permissions of Queue to documenting |
| Properties | A list of remote service bindings properties, including name, owner, remote service, user, anonymous status and ID |
| Permissions | Select this check box to include the permissions of Remote Service Binding to documenting |
| Properties | A list of routes properties, including name, owner, address, mirror address, broker instance, ID, service name and expiration time |
| Permissions | Select this check box to include the permissions of Route to documenting |
| Properties | A list of schemas properties, including name, owner ID and value |
| Permissions | Select this check box to include the permissions of Schemas to documenting |
| Objects | A list of the schema objects including name and type |
| Properties | A list of services properties, including name, owner, queue and ID |
| Permissions | Select this check box to include the permissions of Service to documenting |
| Properties | A list of symmetric keys properties, including name, owner, algorithm, ID, key guid, key length and modify date |
| Permissions | Select this check box to include the permissions of Symmetric Keys to documenting |
| Properties | A list of synonyms properties, including schema, owner, creation date, base object and ID |
| Permissions | Select this check box to include the permissions of Synonyms to documenting |
| Properties | A list of XML schema collection properties, including schema, owner and ID |
| Permissions | Select this check box to include the permissions of XML schema collections to documenting |
Copyright © 2012 ApexSQL LLC. All Rights Reserved.