hana-cli
Version:
HANA Developer Command Line Interface
88 lines (61 loc) • 1.88 kB
Markdown
# inspectProcedure
> Command: `inspectProcedure`
> Category: **Object Inspection**
> Status: Production Ready
## Description
Return metadata about a Stored Procedure
## Syntax
```bash
hana-cli inspectProcedure [schema] [procedure] [options]
```
## Aliases
- `ip`
- `procedure`
- `insProc`
- `inspectprocedure`
- `inspectsp`
## Command Diagram
```mermaid
graph TD
Start([hana-cli inspectProcedure]) --> Inputs{Inputs}
Inputs --> Schema[Schema<br/>default **CURRENT_SCHEMA**]
Inputs --> Name[Procedure name]
Inputs --> OutputType[Output<br/>tbl or sql]
Schema --> Inspect[Read procedure metadata]
Name --> Inspect
OutputType --> Inspect
Inspect --> Done([Command Complete])
style Start fill:#0092d1
style Done fill:#2ecc71
style Inputs fill:#f39c12
```
## Parameters
### Positional Arguments
| Parameter | Type | Description |
|---|---|---|
| `schema` | string | Target schema (optional positional input). |
| `procedure` | string | Procedure name (optional positional input). |
### Options
| Option | Alias | Type | Default | Description |
|---|---|---|---|---|
| `--procedure` | `-p`, `--sp` | string | - | Procedure name to inspect. |
| `--schema` | `-s` | string | `**CURRENT_SCHEMA**` | Schema that contains the procedure. |
| `--output` | `-o` | string | `tbl` | Output format. Choices: `tbl`, `sql`. |
## Examples
### Basic Usage
```bash
hana-cli inspectProcedure --procedure myProcedure --schema MYSCHEMA
```
Execute the command
### SQL Definition Output
```bash
hana-cli inspectProcedure --procedure myProcedure --schema MYSCHEMA --output sql
```
Display the procedure definition in SQL format.
## Related Commands
- [`procedures`](procedures.md)
- [`inspectFunction`](inspect-function.md)
- `callProcedure`
## See Also
- [Category: Object Inspection](..)
- [All Commands A-Z](../all-commands.md)