Skip to content

Commit d3a1c16

Browse files
committed
Chore: Wording -- use time series database
1 parent a403ed0 commit d3a1c16

9 files changed

Lines changed: 20 additions & 20 deletions

File tree

doc/source/about/technologies.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ Infrastructure components
2626

2727
- Kotori_, a data acquisition, graphing and telemetry toolkit
2828
- Grafana_, a graph and dashboard builder for visualizing time series metrics
29-
- CrateDB_, a time-series database ¹
30-
- InfluxDB_, a time-series database ¹
29+
- CrateDB_, a time series database with document features and more ¹
30+
- InfluxDB_, a time series database ¹
3131
- Mosquitto_, an MQTT message broker
3232
- MongoDB_, a document store (optional) ²³
3333

34-
| ¹ Kotori can either use CrateDB or InfluxDB as timeseries database.
34+
| ¹ Kotori can either use CrateDB or InfluxDB as time series database.
3535
| ² MongoDB is only required when doing CSV data acquisition, so it is completely
3636
| optional for regular operations of Kotori.
3737
| ³ As MongoDB - strictly speaking - stopped being free software recently (2018/2019),

doc/source/attic/setup/debian-amd64.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Intro
1616
Install the whole stack on a Debian-based system. It is currently made of these free and open source software components:
1717

1818
- Mosquitto_, a MQTT message broker
19-
- InfluxDB_, a time-series database
19+
- InfluxDB_, a time series database
2020
- Grafana_, a graph and dashboard builder for visualizing time series metrics
2121
- :ref:`Kotori`, a data acquisition, graphing and telemetry toolkit
2222

doc/source/database/cratedb.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This section summarizes CrateDB's data model and query interface.
2525
Data model
2626
==========
2727

28-
As a time-series/document/OLAP/RDBMS database with an SQL interface, CrateDB stores records
28+
As a timeseries/document/OLAP/RDBMS database with an SQL interface, CrateDB stores records
2929
into tables. Tables are grouped into schemas, which is equivalent to the concept of hosting
3030
multiple databases on the same server instance.
3131

@@ -71,7 +71,7 @@ At a glance
7171
- Use standard SQL via the PostgreSQL wire protocol or an HTTP API.
7272
- Dynamic table schemas and queryable objects provide document-oriented features in
7373
addition to the relational features of SQL.
74-
- Support for time-series data, realtime full-text search, geospatial data types and
74+
- Support for time series data, realtime full-text search, geospatial data types and
7575
search capabilities.
7676
- Horizontally scalable, highly available and fault tolerant clusters that run very
7777
well in virtualized and containerised environments.
@@ -315,7 +315,7 @@ Typical queries
315315
Advanced queries
316316
================
317317

318-
Time-series data
318+
Time series data
319319
----------------
320320

321321
.. code-block:: sql
@@ -520,7 +520,7 @@ Usage
520520
Purpose
521521
=======
522522

523-
Kotori uses CrateDB to store **timeseries-data** of data acquisition channels.
523+
Kotori uses CrateDB to store time series data of data acquisition channels.
524524

525525
Documentation
526526
=============

doc/source/database/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Databases
44

55
Database adapter components will know about vendor-specific dialects and optimal
6-
communication strategies to timeseries-databases.
6+
communication strategies to time series databases.
77

88
This documentation section enumerates the collection of database adapters shipped
99
with Kotori. Adding more adapters is possible.
@@ -39,7 +39,7 @@ amounts of data in near real-time, even with complex queries. It is PostgreSQL-c
3939
and based on Lucene.
4040

4141
<small>
42-
<strong>Categories:</strong> timeseries-database, multi-modal database
42+
<strong>Categories:</strong> time series database, multi-modal database
4343
</small>
4444
:::
4545
:::{grid-item}
@@ -68,7 +68,7 @@ and real-time analytics. It covers storing and querying data, background ETL pro
6868
for monitoring and alerting purposes, and visualization and exploration features.
6969

7070
<small>
71-
<strong>Categories:</strong> timeseries-database
71+
<strong>Categories:</strong> time series database
7272
</small>
7373
:::
7474
:::{grid-item}

doc/source/setup/docker.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ telemetry message bus to the database.
9797
CrateDB
9898
=======
9999

100-
This example uses CrateDB as timeseries-database.
100+
This example uses CrateDB as time series database.
101101

102102
Invoke Kotori::
103103

@@ -125,7 +125,7 @@ Go to Grafana and visit the dashboard just created::
125125
InfluxDB
126126
========
127127

128-
This example uses InfluxDB as timeseries-database.
128+
This example uses InfluxDB as time series database.
129129

130130
Invoke Kotori::
131131

kotori/daq/graphing/grafana/manager.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def __init__(self, settings=None, channel=None):
3131
elif "influxdb" in self.config:
3232
self.dbtype = TimeseriesDatabaseType.INFLUXDB1
3333
else:
34-
raise ValueError("Timeseries database type not defined")
34+
raise ValueError("Time series database type not defined")
3535

3636
if not 'port' in self.config['grafana']:
3737
self.config['grafana']['port'] = '3000'
@@ -110,7 +110,7 @@ def create_datasource(self, storage_location):
110110
"password": self.config['influxdb']['password'],
111111
})
112112
else:
113-
log.warn("No time-series database enabled, skipping Grafana provisioning")
113+
log.warn("No time series database enabled, skipping Grafana provisioning")
114114

115115

116116
return datasource_name

kotori/daq/services/mig.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ def setupService(self):
8888
elif "cratedb" in self.settings:
8989
self.database = CrateDBAdapter(settings = self.settings.cratedb)
9090
else:
91-
log.warn("No time-series database configured")
91+
log.warn("No time series database configured")
9292

9393
# Perform MQTT message processing using a different thread pool
9494
self.threadpool = ThreadPool()
@@ -315,7 +315,7 @@ def emit_message(self, message):
315315

316316
def store_message(self, storage, data):
317317
"""
318-
Store data to timeseries database
318+
Store data to time series database
319319
320320
:param storage: The storage location object
321321
:param data: The data ready for storing

kotori/io/export/database.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def query(self):
3737
settings=self.settings.cratedb,
3838
)
3939
else:
40-
log.warn("No time-series database configured")
40+
log.warn("No time series database configured")
4141
return
4242

4343
# Get query expression from transformation dictionary.

test/test_export.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def test_export_cratedb_general(machinery_cratedb, reset_cratedb):
3434
Submit single reading in JSON format to HTTP API and proof
3535
it can be retrieved back from the HTTP API in different formats.
3636
37-
This uses CrateDB as timeseries database.
37+
This uses CrateDB as time series database.
3838
"""
3939

4040
channel_path = settings.io_channel_path
@@ -53,7 +53,7 @@ def test_export_influxdb_general(machinery, create_influxdb, reset_influxdb):
5353
Submit single reading in JSON format to HTTP API and proof
5454
it can be retrieved back from the HTTP API in different formats.
5555
56-
This uses InfluxDB as timeseries database.
56+
This uses InfluxDB as time series database.
5757
"""
5858

5959
channel_path = settings.channel_path_data

0 commit comments

Comments
 (0)