Skip to content

Commit

Permalink
Adding plugin goals.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzonthemtn committed Apr 2, 2024
1 parent ecdafb1 commit e59092d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions documentation/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ The UBI plugin:
* Allows the user to set a `key_field` to be used as a document's unique id instead of the document's `_id` field.
* Manages user-configurable settings (`index` name, `key_field`, and others) of UBI stores.

Things the plugin does not currently do but are goals of the plugin:

* Provide the ability to dump UBI data to a format common for data analysis.
* Facilitate a method of bulk importing of historical data from a non-UBI source.

## UBI Store

The plugin has a concept of a "store", which is a logical collection of the events and queries. A store consists of two indices. One
Expand Down

0 comments on commit e59092d

Please sign in to comment.