help.DefaultExecutable.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

--- Command ---

-c= (short for -command=)
  Where  may be:
    brief
      Shows basic schema information, for tables, views and routines, 
      columns, primary keys, and foreign keys 
    schema
      Shows the commonly needed detail of the schema, including details of 
      tables, views and routines, columns, primary keys, indexes, foreign 
      keys, and triggers
    details
      Shows maximum possible detail of the schema, including privileges, and 
      details of privileges, triggers, and check constraints
    count
      Shows counts of rows in the tables
    dump
      Shows data from all rows in the tables
    
      Shows results of query , as specified in the configuration 
      properties file
    
      Shows results of       
      The query itself can contain the variables ${table}, ${columns} 
      and ${tabletype},  or system properties referenced as 
      ${}
      Queries without any variables are executed exactly once; queries
      with variables are executed once for each table, with the variables
      substituted      
  Optional, default is schema
   may also be a comma-separated list of commands.
  
--- Sort Options ---

-sorttables=
  Sort tables alphabetically
   can be true or false
  Optional, defaults to true
  
-sortcolumns=
  Sort columns in a table alphabetically
   can be true or false
  Optional, defaults to false

-sortinout=
  Sort parameters in a routine alphabetically
   can be true or false
  Optional, defaults to false

--- Output Options ---

-noinfo=
  Hides database information
   can be true or false
  Optional, defaults to false
  
-portablenames=
  Allows for easy comparison between databases, by hiding
  foreign key names, constraint names, trigger names, 
  specific names for routines, or index and primary key names, 
  and not showing the fully-qualified table name
   can be true or false
  Optional, defaults to false
    
-outputformat=
  Format of the SchemaCrawler output, where  is one of:
    text
      For text output (default)
    html
      For HTML5 output
    csv
      For comma-separated values output
    tsv
      For tab-separated values output
    json
      For JavaScript Object Notation output            
  Optional, defaults to text    
      
-o= (short for -outputfile=)
   is the path to the output file
  Optional, defaults to the console (stdout)