You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-docs/influxdb3/core/v3/ref.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ tags:
67
67
68
68
- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.
69
69
- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.
70
-
- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity).
70
+
- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).
71
71
72
72
### Server information
73
73
@@ -118,7 +118,7 @@ tags:
118
118
InfluxDB 3 Core provides the InfluxDB 3 Processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.
119
119
Use Processing engine plugins and triggers to run code and perform tasks for different database events.
120
120
121
-
To get started with the Processing Engine, see the [Processing Engine and Python plugins](/influxdb3/core/processing-engine/) guide.
121
+
To get started with the Processing engine, see the [Processing engine and Python plugins](/influxdb3/core/processing-engine/) guide.
122
122
- name: Quick start
123
123
description: |
124
124
1. [Check the status](#section/Server-information) of the InfluxDB server.
Copy file name to clipboardExpand all lines: api-docs/influxdb3/enterprise/v3/ref.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ tags:
67
67
68
68
- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.
69
69
- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.
70
-
- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity).
70
+
- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).
71
71
72
72
### Server information
73
73
@@ -118,7 +118,7 @@ tags:
118
118
InfluxDB 3 Enterprise provides the InfluxDB 3 Processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.
119
119
Use Processing engine plugins and triggers to run code and perform tasks for different database events.
120
120
121
-
To get started with the Processing Engine, see the [Processing Engine and Python plugins](/influxdb3/enterprise/processing-engine/) guide.
121
+
To get started with the Processing engine, see the [Processing engine and Python plugins](/influxdb3/enterprise/processing-engine/) guide.
122
122
- name: Quick start
123
123
description: |
124
124
1. [Check the status](#section/Server-information) of the InfluxDB server.
#### Example: query the `cpu` table, limiting to 10 rows:
480
483
481
-
```
484
+
```console
482
485
$ influxdb3 query --database=servers "SELECT DISTINCT usage_percent, time FROM cpu LIMIT 10"
483
486
+---------------+---------------------+
484
487
| usage_percent |time|
@@ -496,7 +499,7 @@ $ influxdb3 query --database=servers "SELECT DISTINCT usage_percent, time FROM c
496
499
+---------------+---------------------+
497
500
```
498
501
499
-
### Querying using the CLI for InfluxQL
502
+
### Query using the CLI for InfluxQL
500
503
501
504
[InfluxQL](/influxdb3/version/reference/influxql/) is an SQL-like language developed by InfluxData with specific features tailored for leveraging and working with InfluxDB. It’s compatible with all versions of InfluxDB, making it a good choice for interoperability across different InfluxDB installations.
502
505
@@ -540,13 +543,13 @@ We recommend installing the required packages in a Python virtual environment fo
540
543
541
544
To get started, install the `influxdb3-python` package.
542
545
543
-
```
546
+
```bash
544
547
pip install influxdb3-python
545
548
```
546
549
547
550
From here, you can connect to your database with the client library using just the **host** and **database name:
548
551
549
-
```py
552
+
```python
550
553
from influxdb_client_3 import InfluxDBClient3
551
554
552
555
client = InfluxDBClient3(
@@ -558,7 +561,7 @@ client = InfluxDBClient3(
558
561
The following example shows how to query using SQL, and then
559
562
use PyArrow to explore the schema and process results:
560
563
561
-
```py
564
+
```python
562
565
from influxdb_client_3 import InfluxDBClient3
563
566
564
567
client = InfluxDBClient3(
@@ -591,27 +594,16 @@ For more information about the Python client library, see the [`influxdb3-python
591
594
### Last values cache
592
595
593
596
{{% product-name %}} supports a **last-n values cache** which stores the last N values in a series or column hierarchy in memory. This gives the database the ability to answer these kinds of queries in under 10 milliseconds.
594
-
You can use the `influxdb3` CLI to create a last value cache.
-h, --host <HOST_URL> Host URL of the running InfluxDB 3 server
650
-
-d, --database <DATABASE_NAME> The database to run the query against
651
-
--token <AUTH_TOKEN> The token for authentication
652
-
-t, --table <TABLE> The table for which the cache is being deleted
653
-
-n, --cache-name <CACHE_NAME> The name of the cache being deleted
654
-
--help Print help information
649
+
influxdb3 delete last_cache \
650
+
-d <DATABASE_NAME> \
651
+
-t <TABLE> \
652
+
--cache-name <CACHE_NAME>
655
653
```
656
654
657
655
### Distinct values cache
658
656
659
-
Similar to the Last values cache, the database can cache in RAM the distinct values fora single columnin a table or a heirarchy of columns. This is useful forfast metadata lookups, which can returnin under 30 milliseconds. Many of the options are similar to the last value cache. See the CLI output for more information:
657
+
Similar to the Last values cache, the database can cache in RAM the distinct values fora single columnin a table or a hierarchy of columns. This is useful forfast metadata lookups, which can returnin under 30 milliseconds. Many of the options are similar to the last value cache. See the CLI output for more information:
660
658
661
659
```bash
662
660
influxdb3 create distinct_cache -h
@@ -784,7 +782,7 @@ To test a plugin, do the following:
784
782
```bash
785
783
influxdb3 test wal_plugin \
786
784
--lp <INPUT_LINE_PROTOCOL> \
787
-
--input-arguments "arg1=foo,arg2=bar"
785
+
--input-arguments "arg1=foo,arg2=bar" \
788
786
--database <DATABASE_NAME> \
789
787
<PLUGIN_FILENAME>
790
788
```
@@ -833,7 +831,3 @@ enable the trigger and have it run the plugin as you write data:
833
831
```bash
834
832
influxdb3 enable trigger --database mydb trigger1
835
833
```
836
-
837
-
For more information, see [Python plugins and the Processing engine](/influxdb3/version/plugins/).
0 commit comments