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/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
+23-1Lines changed: 23 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -229,7 +229,29 @@ paths:
229
229
name: rp
230
230
schema:
231
231
type: string
232
-
description: Retention policy name.
232
+
description: |
233
+
The retention policy name for InfluxQL queries
234
+
235
+
Optional parameter that specifies the retention policy to use when querying data with InfluxQL. In Cloud Serverless, this parameter works with DBRP (Database Retention
236
+
Policy) mappings to identify the target bucket.
237
+
238
+
When provided together with the `db` parameter, Cloud Serverless uses the DBRP mapping to determine which bucket to query. The combination of `db` and `rp` must have an
239
+
existing DBRP mapping that points to a bucket. If no `rp` is specified, Cloud Serverless uses the default retention policy mapping for the database.
240
+
241
+
Requirements: A DBRP mapping must exist for the db/rp combination before you can query data. DBRP mappings can be created:
242
+
- Automatically when writing data with the v1 API (if your token has sufficient permissions)
243
+
- Manually using the InfluxDB CLI or API
244
+
245
+
Example: If `db=mydb` and `rp=weekly`, the query uses the DBRP mapping for `mydb/weekly` to determine which bucket to query.
246
+
247
+
_Note: The retention policy name is used only for DBRP mapping. Actual data retention is controlled by the target bucket's retention period setting, not by the retention
248
+
policy name._
249
+
250
+
### Related
251
+
252
+
- [Use the InfluxDB v1 query API and InfluxQL in Cloud Serverless](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/)
253
+
- [Map v1 databases and retention policies to buckets in Cloud Serverless](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets)
254
+
- [Migrate from InfluxDB 1.x to Cloud Serverless](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/)
233
255
- name: epoch
234
256
description: |
235
257
Formats timestamps as unix (epoch) timestamps with the specified precision
0 commit comments