diff --git a/cmd/import.go b/cmd/import.go index f998bd4b3..250dccfd3 100644 --- a/cmd/import.go +++ b/cmd/import.go @@ -59,7 +59,7 @@ omitted. If it is present then its format should be YYYY-MM-DDTHH:MM. flags.IntVarP(&Importer.BufferSize, "buffer-size", "s", 10000000, "Number of bits to buffer/sort before importing.") flags.BoolVarP(&Importer.Sort, "sort", "", false, "Enables sorting before import.") flags.BoolVarP(&Importer.CreateSchema, "create", "e", false, "Create the schema if it does not exist before import.") - flags.Var(&Importer.IndexOptions.TimeQuantum, "index-time-quantum", "Time quantum for the index") + flags.Var(&Importer.IndexOptions.TimeQuantum, "index-time-quantum", "Time quantum for the index (DEPRECATED. This feature will be removed in a future version. Set time quantum of each frame instead.)") flags.Var(&Importer.FrameOptions.TimeQuantum, "frame-time-quantum", "Time quantum for the frame") flags.BoolVar(&Importer.FrameOptions.InverseEnabled, "frame-inverse-enabled", false, "Enable inverse frame") flags.BoolVar(&Importer.FrameOptions.RangeEnabled, "frame-range-enabled", false, "Enabled range encoded frame") diff --git a/docs/api-reference.md b/docs/api-reference.md index 5129f4061..206c30f55 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -45,15 +45,9 @@ Response: Creates an index with the given name. -The request payload is in JSON, and may contain the `options` field. The `options` field is a JSON object which may contain the following fields: - -* `timeQuantum` (string): time quantum of the index. - Request: ``` -curl localhost:10101/index/user \ - -X POST \ - -d '{"options": {"timeQuantum": "YMDH"}}' +curl -XPOST localhost:10101/index/user ``` Response: @@ -117,38 +111,6 @@ Response: By default, all bits and attributes (*for `Bitmap` queries only*) are returned. In order to suppress returning bits, set `excludeBits` query argument to `true`; to suppress returning attributes, set `excludeAttrs` query argument to `true`. -### Change index time quantum - -`PATCH /index//time-quantum` - -Changes the time quantum for the given index. This endpoint should be called at most once right after creating a database. - -The payload is in JSON with the format: `{"timeQuantum": "${TIME_QUANTUM}"}`. Valid time quantum values are: - -* (Empty string) -* Y: year -* M: month -* D: day -* H: hour -* YM: year and month -* MD: month and day -* DH: day and hour -* YMD: year, month and day -* MDH: month, day and hour -* YMDH: year, month, day and hour - -Request: -``` -curl localhost:10101/index/user/time-quantum \ - -X POST \ - -d '{"timeQuantum": "YM"}' -``` - -Response: -``` -{} -``` - ### Create frame `POST /index//frame/` diff --git a/docs/webui.md b/docs/webui.md index a348f59a6..cef8e570d 100644 --- a/docs/webui.md +++ b/docs/webui.md @@ -30,7 +30,7 @@ In addition to standard PQL, the console supports a few special commands, prefix - `:create frame ` - `:delete frame ` -Index and frame creation also supports options like `timeQuantum` or `inverseEnabled`. When creating new index or new frame, add options by using the keys documented in [API reference](../api-reference). +Frame creation also supports options like `timeQuantum` or `inverseEnabled`. When creating a new frame, add options by using the keys documented in [API reference](../api-reference). - `:create index timeQuantum=YM` - `:create frame inverseEnabled=true cacheSize=10000`