On this page

LIB SHOW

Core command LI SH LISH

Shows the content and the declared parameters of a Script of the Scripts Library.

Syntax

LIB SHOW <script>

Arguments

Argument	Required	Values	Default
`<script>`	Yes	A path relative to the Scripts Library root, exactly as written; no extension is added	None

Examples

LIB SHOW maintenance/cleanup.bsql

Example session

LIB SHOW countries/largest.sql;
Content of Scripts Library script: countries/largest.sql
Parameters:
|--------------|-------|--------|--------|----------------------------------|
|Name          |Type   |Required|Default |Description                       |
|--------------|-------|--------|--------|----------------------------------|
|continent     |TEXT   |Yes     |        |Continent, as in COUNTRY.CONTINENT|
|min_population|INTEGER|No      |50000000|Smallest population listed        |
|--------------|-------|--------|--------|----------------------------------|

LIB SHOW prints the declared parameters

Details

The name is a path relative to the library root, exactly as LIB RUN takes it. The command prints:

a warning for each @instance, @environment or @dialect tag of the Script that does not match the current connection; the content is shown anyway;
the parameters its -- @params: lines declare, or Parameters: none declared; when it declares typed parameters (-- @param), a table of their name, type, whether each is required, default and description, followed by any problem in those declarations;
its declared access (Access: read (declared, not verified)) and dialects, when it declares them. An access declaration is information only: BroadSQL does not check or enforce it when the Script runs;
the full content, metadata header included.

A name that the library does not contain is an error.

Used in these how-tos

Last modified in release 5.5.0.

Found something wrong or unclear on this page? Tell us, with the page address.