hana-cli
Version:
HANA Developer Command Line Interface
91 lines (65 loc) • 2.38 kB
Markdown
# timeSeriesTools
> Command: `timeSeriesTools`
> Category: **System Tools**
> Status: Production Ready
## Description
Analyze and operate on time-series data.
## Syntax
```bash
hana-cli timeSeriesTools [action] [options]
```
## Command Diagram
```mermaid
graph TD
Start([hana-cli timeSeriesTools]) --> Action{action}
Action -->|list| List[List time-series tables]
Action -->|analyze| Analyze[Analyze table statistics]
Action -->|aggregate| Aggregate[Aggregate by interval]
Action -->|forecast| Forecast[Run forecast flow]
Action -->|detect| Detect[Detect anomalies]
Action -->|info| Info[Show capabilities]
List --> Complete([Command Complete])
Analyze --> Complete
Aggregate --> Complete
Forecast --> Complete
Detect --> Complete
Info --> Complete
style Start fill:#0092d1
style Complete fill:#2ecc71
style Action fill:#f39c12
```
## Aliases
- `tsTools`
- `timeseries`
- `timeseriestools`
## Parameters
### Positional Arguments
| Parameter | Type | Description |
|-----------|------|-------------|
| `action` | string | Action to perform |
### Options
| Option | Alias | Type | Default | Description |
|--------|-------|------|---------|-------------|
| `--action` | `-a` | string | `list` | Action. Choices: `list`, `analyze`, `aggregate`, `forecast`, `detect`, `info` |
| `--table` | `-t`, `--Table` | string | - | Target table |
| `--table` | `-t` | string | - | Target table |
| `--schema` | `-s` | string | `**CURRENT_SCHEMA**` | Schema name |
| `--timeColumn` | `--tc` | string | - | Timestamp column |
| `--valueColumn` | `--vc` | string | - | Numeric value column |
| `--interval` | `-i` | string | `HOUR` | Aggregation interval. Choices: `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH` |
| `--limit` | `-l` | number | `1000` | Maximum rows returned |
For a complete list of parameters and options, use:
```bash
hana-cli timeSeriesTools --help
```
## Examples
### Basic Usage
```bash
hana-cli timeSeriesTools --action analyze --table TIMESERIES_DATA
```
Run the analyze action for the specified time-series table.
## 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)