Day 1: Documenting the Database Environment

Hi everyone,

Today is my first day blogging my current experience dealing with oracle database as database administrator and Applications administrator. I decided to start with documenting the environment I work with as this task is really missing out of most DBAs. To review more information about the importance of documentation google for “The Art of Being a Successful DBA” from Remote DBA web site.

So today I’ll document the environment I work with like if it is the first time I meet this database(s).

Database Settings Document

The basic and most important documents that every DBA must create for each database are one for database settings, server settings and key files. The database settings document will contain the database settings that most requently used when doing daily activities with this database. The reason why not just get this information while logging in to the database is that sometimes you need such information while the database is not abailable or when something goes wrong and you need to know the database ID for example to complete a recovery operation, so you must keep such information in a location not related to the database or the server holding it.

Settings Document Sections

The first section of your database settings document could hold information such as database name, instance name, host name, database version, database id, platform used, oracle home, open mode, working hours and these are only the basic settings for each database and you should add any information you find related or might help you in your working journey with this database.

The second section may hold the database file system settings that contains each file system used with database along with the used and available space.

The next section may contain the archive log settings such as archive log mode and destination and any information related.

The last section in my document will contain the storage information with the name and location of each database files and could also contain the size of each file.

Create your own document

Again this is my review for the database settings document and you should create one that is suited for you and convenient to your working environment and your company profile. Also one may add any related information he found interested and should be placed somewhere in any section.

Consider DBA Templates

A good practice is to keep a template for each document you use frequently so as not to create it from the beginning each time you use it. and it is also useful to keep a DBA Templates folder that hold each template document you create as to keep track with them and to update with any new settings you find along the way.

Day 1 Tasks:

1. Create a db_settings.doc template documents with the sections mentioned.
2. Update one template for each database you have so you have documented each database you work with.
3. Keep a copy on the database server and another one on your PC.

Regards

Mostafa Mahmoud

Oracle DBA