hana-cli/docs/02-commands/system-tools/synonyms.md

HANA Developer Command Line Interface

# synonyms

> Command: `synonyms`  
> Category: **System Tools**  
> Status: Production Ready

## Description

List and inspect synonyms and their target objects.

## Syntax

```bash
hana-cli synonyms [schema] [synonym] [target] [options]
```

## Command Diagram

```mermaid
    graph TD
        Start([hana-cli synonyms]) --> Inputs[Read schema/synonym/target filters]
        Inputs --> Query[Query SYNONYMS metadata]
        Query --> Output[Render synonym mapping table]
        Output --> Complete([Command Complete])

        style Start fill:#0092d1
        style Complete fill:#2ecc71
```

## Aliases

- `syn`
- `listSynonyms`
- `listsynonyms`

## Parameters

### Positional Arguments

| Parameter | Type | Description |
|-----------|------|-------------|
| `schema` | string | Schema filter (optional) |
| `synonym` | string | Synonym name/pattern (optional) |
| `target` | string | Target object name/pattern (optional) |

### Options

| Option | Alias | Type | Default | Description |
|--------|-------|------|---------|-------------|
| `--synonym` | `--syn` | string | `*` | Synonym filter |
| `--target` | `-t` | string | `*` | Target object filter |
| `--schema` | `-s` | string | `**CURRENT_SCHEMA**` | Schema name |
| `--limit` | `-l` | number | `200` | Maximum rows returned |

For a complete list of parameters and options, use:

```bash
hana-cli synonyms --help
```

## Examples

### Basic Usage

```bash
hana-cli synonyms --schema MYSCHEMA --synonym %
```

List synonyms and their target objects in the selected schema.

## Related Commands

See the [Commands Reference](../all-commands.md) for other commands in this category.

## See Also

- [Category: System Tools](..)
- [All Commands A-Z](../all-commands.md)