help.SchemaCrawlerOptions.txt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 16.22.2

Show newest version

--- Filtering Options ---
     
-i= (short for -infolevel=)
   is one of minimum, standard, detailed, or maximum
  The info level determines the amount of database metadata retrieved,
  and also determines the time taken to crawl the schema
       
-schemas=
   is a regular expression to match fully qualified schema 
  namess, in the form "CATALOGNAME.SCHEMANAME" - for example,
  -schemas=.*\.C.*|.*\.P.*
  matches any schemas whose names start with C or P
  Schemas that do not match the pattern are not displayed
  Optional, defaults to showing all schemas
  
-tabletypes=
   is a comma-separated list of table types supported by the
  database
  If no value is specified, all types of tables are shown
  Optional, defaults to TABLE,VIEW
  
-tables=
   is a regular expression to match fully qualified table 
  names, in the form "CATALOGNAME.SCHEMANAME.TABLENAME" - for example, 
  -tables=.*\.C.*|.*\.P.*
  matches any tables whose names start with C or P
  Tables that do not match the pattern are not displayed
  Use with care, since -tables= actually takes tables out of
  consideration from the perspective of SchemaCrawler
  To filter tables, look into the grep options
  Optional, defaults to showing all tables
    
-excludecolumns=
   is a regular expression to match fully qualified column 
  names, in the form "CATALOGNAME.SCHEMANAME.TABLENAME.COLUMNNAME" - for example, 
  -excludecolumns=.*\.STREET|.*\.PRICE
  matches columns named STREET or PRICE in any table
  Columns that match the pattern are not displayed
  Optional, default is to show all columns

-routinetypes=
   is a comma-separated list of routine types of 
  PROCEDURE,FUNCTION
  Optional, defaults to PROCEDURE,FUNCTION
        
-routines=
   is a regular expression to match fully qualified  
  stored procedure or function names, in the form 
  "CATALOGNAME.SCHEMANAME.ROUTINENAME" - for example, 
  -routines=.*\.C.*|.*\.P.*
  matches any routines whose names start with C or P
  Routines that do not match the pattern are not displayed
  Use -routines= to omit routines
  Optional, defaults to showing all routines
    
-excludeinout=
   is a regular expression to match fully qualified 
  parameter names - for example, 
  -excludeinout=@p1|@p2
  matches parameters named @p1 or @p2 in any procedure 
  Parameters that match the pattern are not displayed
  Optional, default is to show all parameters

-synonyms=
   is a regular expression to match fully qualified synonym 
  names, in the form "CATALOGNAME.SCHEMANAME.SYNONYMNAME" - for example, 
  -synonyms=.*\.C.*|.*\.P.*
  matches any synonyms whose names start with C or P
  Synonyms that do not match the pattern are not displayed
  Synonyms will only be shown when -infolevel=maximum
  Use -synonyms= to omit synonyms
  Optional, defaults to showing no synonyms

-sequences=
   is a regular expression to match fully qualified sequence 
  names, in the form "CATALOGNAME.SCHEMANAME.SEQUENCENAME" - for example, 
  -sequences=.*\.C.*|.*\.P.*
  matches any sequences whose names start with C or P
  Sequences that do not match the pattern are not displayed
  Use -sequences= to omit sequences
  Sequences will only be shown when -infolevel=maximum
  Optional, defaults to showing no sequences

--- Grep Options ---
    
-grepcolumns=
   is a regular expression to match fully qualified 
  column names, in the form "SCHEMANAME.TABLENAME.COLUMNNAME" - for example,
  -grepcolumns=.*\.STREET|.*\.PRICE
  matches columns named STREET or PRICE in any table
  Optional, default is no grep
   
-grepinout=
   is a regular expression to match fully qualified 
  inout names, in the form "SCHEMANAME.TABLENAME.INOUTNAME" - for example,
  -grepinout=.*\.STREET|.*\.PRICE
  matches inouts named STREET or PRICE in any table
  Optional, default is no grep
  
-grepdef=
   is a regular expression to match text within remarks and
  definitions of views, stored proedures and triggers, if available
  Optional, default is no grep
    
-invert-match   
  Inverts the sense of matching, and shows non-matching tables and columns
  Optional, default is false

-only-matching
  Shows only matching tables, and does not show foreign keys that reference
  other non-matching tables
  Optional, default is false

-hideemptytables
  Shows only tables that have rows of data
  Will work only if infolevel is maximum
  Optional, default is false
    
-parents=
   is the number of generations of ancestors
  for the tables selected by grep, and shown in the results
  Optional, default is 0
  
-children=
   is the number of generations of descendants
  for the tables selected by grep, and shown in the results
  Optional, default is 0