Altering Oracle's SQL*Plus Help Facility - Page 3

June 4, 2003

Rebuild INDEX

Unfortunately, the rebuilding of the INDEX content is not quite as easy as the TOPICS and you may decide not to provide this since the same information is available through the TOPICS content that we just rebuilt. If you do want to keep up on changing the INDEX content you should first cut and paste the content from the helpus.sql script into a file called index_content.sql and maintain all your future changes there.

Here is my current index_content.sql, after I have added the 'CREATE TABLESPACE' content. Notice that all I have added is an 'EXTRA' area at the bottom from lines 19 thru 22. You may call it anything you wish or rearrange the lines so that you can convey it to your users in the method best for them.


Download Index_content.sql

After you have built your index_content.sql script you are now ready to install it. This is a simple two step process.

1.      Delete the old INDEX content

DELETE FROM HELP WHERE TOPIC = 'INDEX';

2.      Rebuild the INDEX content through index_content.sql script.

@index

3.      Commit Your work

COMMIT:

Validate Help

Once everything is loaded and rebuilt, it is time to make sure it all works. Here is our newly built content:

SQL> HELP create tablespace

 CREATE TABLESPACE (9.2)
 ---------------------------------------
CREATE [UNDO] TABLESPACE tablespace
[DATAFILE datafile_tempfile_spec [, datafile_tempfile_spec]... ]
[{ MINIMUM EXTENT integer [ K | M ]
 | BLOCKSIZE integer [K]
 | logging_clause
 | FORCE LOGGING
 | DEFAULT [data_segment_compression] storage_clause
 | { ONLINE | OFFLINE }
 | { PERMANENT | TEMPORARY }
 | extent_management_clause
 | segment_management_clause
 }
 [ MINIMUM EXTENT integer [ K | M ]
 | BLOCKSIZE integer [K]
 | logging_clause
 | FORCE LOGGING
 | DEFAULT [data_segment_compression] storage_clause
 | { ONLINE | OFFLINE }
 | { PERMANENT | TEMPORARY }
 | extent_management_clause
 | segment_management_clause
 ]...
]
;

datafile_tempfile_spec
['filename'] [SIZE integer [ K | M ]] [REUSE] [autoextend_clause]

autoextend_clause
AUTOEXTEND { OFF | ON [ NEXT integer [ K | M ] ] [maxsize_clause] }

logging_clause
{LOGGING | NOLOGGING}

data_segment_compression
{ COMPRESS | NOCOMPRESS }

storage_clause
STORAGE
( { INITIAL integer [ K | M ]
  | NEXT integer [ K | M ]
  | MINEXTENTS integer
  | MAXEXTENTS { integer | UNLIMITED }
  | PCTINCREASE integer
  | FREELISTS integer
  | FREELIST GROUPS integer
  | OPTIMAL [ integer [ K | M ] | NULL ]
  | BUFFER_POOL { KEEP | RECYCLE | DEFAULT }
  }
  [ INITIAL integer [ K | M ]
  | NEXT integer [ K | M ]
  | MINEXTENTS integer
  | MAXEXTENTS { integer | UNLIMITED }
  | PCTINCREASE integer
  | FREELISTS integer
  | FREELIST GROUPS integer
  | OPTIMAL [ integer [ K | M ] | NULL ]
  | BUFFER_POOL { KEEP | RECYCLE | DEFAULT }
  ]...
)

extent_management_clause
EXTENT MANAGEMENT
{ DICTIONARY | LOCAL [ AUTOALLOCATE | UNIFORM [SIZE integer [ K | M ]]] }

segment_management_clause
SEGMENT SPACE MANAGEMENT { MANUAL | AUTO }

ISQL*PLUS

If you like using iSQL*Plus, the HELP facility is also available through it. Just enter the HELP command in the statement area and hit the EXECUTE button.

Having to work in command line all day and not having access to any manuals is sometimes the way we must work. If you are like me and forget the exact syntax to some of the commands the HELP facility is a very quick and easy way to store the information you need so that it is readily available. In addition, you can also supply your development staff with other insightful information about the use of the Oracle database that they would not normally have documentation on. For instance, just think of the possibilities for you to develop a HELP ENV command that describes the current machine or settings needed for a particular process. The possibilities are endless.

» See All Articles by Columnist James Koopmann








The Network for Technology Professionals

Search:

About Internet.com

Legal Notices, Licensing, Permissions, Privacy Policy.
Advertise | Newsletters | E-mail Offers