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
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.
--- 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
quickdump
Shows data from all rows in the tables, but row order is not guaranteed -
this can be used with a -infolevel=minimum for speed
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 ---
-title=
Shows the title text as the title on the output
Optional, defaults to no title being shown
-noinfo=<boolean>
Hides database information
<boolean> can be true or false
Optional, defaults to false
-noremarks=<boolean>
Hides table and column remarks
<boolean> can be true or false
Optional, defaults to false
-portablenames=<boolean>
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
<boolean> can be true or false
Optional, defaults to false
-outputformat=<outputformat>
Format of the SchemaCrawler output, where <outputformat> 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=<outputfile> (short for -outputfile=<outputfile>)
<outputfile> is the path to the output file
Optional, defaults to the console (stdout)
</code></pre> <br/>
<br/>
<!--<div id="right-banner">-->
<!--</div>-->
<!--<div id="left-banner">-->
<!--</div>-->
<div class='clear'></div>
</main>
</div>
<br/><br/>
<div class="align-center">© 2015 - 2024 <a href="/legal-notice.php">Weber Informatics LLC</a> | <a href="/data-protection.php">Privacy Policy</a></div>
<br/><br/><br/><br/><br/><br/>
</body>
</html>