Skip to content

Commit 21f8723

Browse files
billy-the-fishbilly-the-fish
authored
Merge branch 'latest' into 4576-failing-link-check-monday-november-17th
2 parents 3365238 + bd22d79 commit 21f8723

File tree

3 files changed

+74
-1
lines changed

3 files changed

+74
-1
lines changed

‎_partials/_devops-cli-reference.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ You can use the following commands with $CLI_LONG. For more information on each
2525
| | get `<service-id>` <br/>aliases: `describe`, `show` | Show detailed information about a specific $SERVICE_SHORT in this $PROJECT_SHORT |
2626
| | list | List all the $SERVICE_SHORTs in this $PROJECT_SHORT |
2727
| | update-password `<service-id>` | Update the master password for a $SERVICE_SHORT |
28+
| | start `<service-id>` | Start a $SERVICE_SHORT that is currently inactive. Possible flags are: <ul><li>`--no-wait`: don't wait for the operation to complete</li><li>`--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`</li></ul> |
29+
| | stop `<service-id>` | Stop a $SERVICE_SHORT that is currently active. After you run this command `<service-id>` no longer accepts connections. Possible flags are: <ul><li>`--no-wait`: don't wait for the operation to complete</li><li>`--wait-timeout`: set the maximum wait time for this operation to complete. For example, `10m` (default), `30m`, `1h30m`, `90s`</li></ul> |
2830
| db | | Database operations and management |
2931
| | connect `<service-id>` | Connect to a $SERVICE_SHORT |
3032
| | connection-string `<service-id>` | Retrieve the connection string for a $SERVICE_SHORT |

‎api/api-reference.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,78 @@ Change the HA configuration for a service. This is an asynchronous operation.
276276

277277
**Response:** `202 Accepted`
278278

279+
### Stop a Service
280+
281+
```http
282+
POST /projects/{project_id}/services/{service_id}/stop
283+
```
284+
285+
Stop a running service. This is an asynchronous operation.
286+
287+
**Response:** `202 Accepted`
288+
```json
289+
{
290+
"service_id": "p7zm9wqqii",
291+
"project_id": "jz22xtzemv",
292+
"name": "test-2",
293+
"region_code": "eu-central-1",
294+
"service_type": "TIMESCALEDB",
295+
"created": "2025-09-04T20:46:46.26568Z",
296+
"paused": false,
297+
"status": "PAUSING",
298+
"resources": [
299+
{
300+
"id": "100927",
301+
"spec": {
302+
"cpu_millis": 1000,
303+
"memory_gbs": 4,
304+
"volume_type": ""
305+
}
306+
}
307+
],
308+
"endpoint": {
309+
"host": "p7zm8wqqii.jz4qxtzemv.tsdb.cloud.timescale.com",
310+
"port": 35482
311+
}
312+
}
313+
```
314+
315+
### Start a Service
316+
317+
```http
318+
POST /projects/{project_id}/services/{service_id}/start
319+
```
320+
321+
Start a stopped service. This is an asynchronous operation.
322+
323+
**Response:** `202 Accepted`
324+
```json
325+
{
326+
"service_id": "p7zm9wqqii",
327+
"project_id": "jz22xtzemv",
328+
"name": "test-2",
329+
"region_code": "eu-central-1",
330+
"service_type": "TIMESCALEDB",
331+
"created": "2025-09-04T20:46:46.26568Z",
332+
"paused": false,
333+
"status": "RESUMING",
334+
"resources": [
335+
{
336+
"id": "100927",
337+
"spec": {
338+
"cpu_millis": 1000,
339+
"memory_gbs": 4,
340+
"volume_type": ""
341+
}
342+
}
343+
],
344+
"endpoint": {
345+
"host": "p7zm8wqqii.jz4qxtzemv.tsdb.cloud.timescale.com",
346+
"port": 35482
347+
}
348+
}
349+
```
350+
279351
### Connection Pooler Management
280352

281353
#### Enable Connection Pooler

‎api/continuous-aggregates/alter_materialized_view.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ ALTER MATERIALIZED VIEW <view_name> SET ( timescaledb.<argument> = <value> [, .
7070
| `timescaledb.compress_segmentby` | TEXT | No segementation by column. | ✖ | Set the list of columns used to segment the compressed data. An identifier representing the source of the data such as `device_id` or `tags_id` is usually a good candidate. |
7171
| `column_name` | TEXT | - | ✖ | Set the name of the column to order by or segment by. |
7272
| `timescaledb.compress_chunk_time_interval` | TEXT | - | ✖ | Reduce the total number of compressed/columnstore chunks for `table`. If you set `compress_chunk_time_interval`, compressed/columnstore chunks are merged with the previous adjacent chunk within `chunk_time_interval` whenever possible. These chunks are irreversibly merged. If you call to [decompress][decompress]/[convert_to_rowstore][convert_to_rowstore], merged chunks are not split up. You can call `compress_chunk_time_interval` independently of other compression settings; `timescaledb.compress`/`timescaledb.enable_columnstore` is not required. |
73-
| `timescaledb.enable_cagg_window_functions` | BOOLEAN | `false` | ✖ | EXPERIMENTAL: enable window functions on continuous aggregates. Support is experimental, as there is a risk of data inconsistency. For example, in backfill scenarios, buckets could be missed. |
7473
| `timescaledb.chunk_interval` (formerly `timescaledb.chunk_time_interval`) | INTERVAL | 10x the original hypertable. | ✖ | Set the chunk interval. Renamed in $TIMESCALE_DB V2.20. |
7574

7675

0 commit comments

Comments
 (0)