mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-09-13 16:11:01 +00:00
remove references to Input Defintion from the docs
This commit is contained in:
Travis Turner
parent
7f71b1649c
commit
8c2387b45e
3 changed files with 0 additions and 143 deletions
|
|
@ -198,129 +198,6 @@ curl localhost:10101/index/repository/frame/stats/field/pullrequests \
|
|||
{}
|
||||
```
|
||||
|
||||
### Create input definition
|
||||
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of v0.9.
|
||||
</div>
|
||||
|
||||
`POST /index/<index-name>/input-definition/<input-definition-name>`
|
||||
|
||||
Creates an input definition in the given index with the given name.
|
||||
|
||||
The request payload is JSON, and it must contain the fields `frames` and `fields`. `frames` is an array of frames used within this input definition. Each frame must contain a `name` and may contain the following options:
|
||||
|
||||
* `timeQuantum` (string): [Time Quantum](../data-model/#time-quantum) for this frame.
|
||||
* `inverseEnabled` (boolean): Enables [the inverted view](../data-model/#inverse) for this frame if `true`.
|
||||
* `cacheType` (string): [ranked](../data-model/#ranked) or [LRU](../data-model/#lru) caching on this frame. Default is `lru`.
|
||||
* `cacheSize` (int): Number of rows to keep in the cache. Default 50,000.
|
||||
|
||||
The `fields` array contains a series of JSON objects describing how to process each field received in the input data. Each `field` object must contain a `name` which maps to the source JSON field name. One field must be defined at the `primaryKey`. The `primarykey` source field's value must be an unsigned integer which maps directly to a columnID in Pilosa.
|
||||
|
||||
* `name` (string): Maps the source data field to actions that process the field's corresponding value.
|
||||
* `actions` (array): List of actions that will process the field's value.
|
||||
|
||||
The `action` describes how the field value will be processed. Each `action` may contain:
|
||||
|
||||
* `frame` (string): The Frame that will contain this action's set bits.
|
||||
* `rowid` (int): The action can use this as a pre-defined SetBit rowID. The user is required to ensure this ID does not overlap with other rows in use per frame.
|
||||
* `valueDestination` (string): The mapping rule used for this data.
|
||||
- `value-to-row`: The value should be an integer and will map directly to a RowID.
|
||||
- `single-row-boolean`: If the value is true set a bit using the `rowid`.
|
||||
- `mapping`: Map the value to a RowID in the `valueMap`.
|
||||
* `valueMap` (object): string and integer pairs used to map field values to RowID's.
|
||||
|
||||
``` request
|
||||
curl localhost:10101/index/user/input-definition/stargazer-input \
|
||||
-X POST \
|
||||
-d '{
|
||||
"frames":[
|
||||
{
|
||||
"name": "language",
|
||||
"options": {"inverseEnabled": true}
|
||||
}
|
||||
],
|
||||
"fields":[
|
||||
{
|
||||
"name": "repo_id",
|
||||
"primaryKey":true
|
||||
},
|
||||
{
|
||||
"name": "language_id",
|
||||
"actions":[
|
||||
{
|
||||
"frame": "language",
|
||||
"valueDestination": "mapping",
|
||||
"valueMap": {
|
||||
"Go": 5,
|
||||
"Python": 17,
|
||||
"C++": 10
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}'
|
||||
```
|
||||
``` response
|
||||
{}
|
||||
```
|
||||
|
||||
### Get input definition
|
||||
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of v0.9.
|
||||
</div>
|
||||
|
||||
`GET /index/<index-name>/input-definition/<input-definition-name>`
|
||||
|
||||
Returns the given input definition as JSON.
|
||||
|
||||
``` request
|
||||
curl -XGET localhost:10101/index/user/input-definition/stargazer-input
|
||||
```
|
||||
``` response
|
||||
{"frames":[{"name":"language","options":{"inverseEnabled":true}}],"fields":[{"name":"repo_id","primaryKey":true},{"name":"language_id","actions":[{"frame":"language","valueDestination":"mapping","valueMap":{"Go":5,"Python":17,"C++":10}}]}]}
|
||||
```
|
||||
|
||||
### Remove input definition
|
||||
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of v0.9.
|
||||
</div>
|
||||
|
||||
`DELETE /index/<index-name>/input-definition/<input-definition-name>`
|
||||
|
||||
Removes the given input definition.
|
||||
|
||||
``` request
|
||||
curl -XDELETE localhost:10101/index/user/input-definition/stargazer-input
|
||||
```
|
||||
``` response
|
||||
{}
|
||||
```
|
||||
|
||||
### Process input data
|
||||
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of v0.9.
|
||||
</div>
|
||||
|
||||
`POST /index/<index-name>/input/<input-definition-name>`
|
||||
|
||||
Processes the JSON payload using the given input definition.
|
||||
|
||||
The request payload is a JSON array of objects containing one field for the primary key that corresponds to the column, and additional fields that will be handled by corresponding actions in the input definition.
|
||||
|
||||
``` request
|
||||
curl localhost:10101/index/user/input/stargazer-input \
|
||||
-X POST \
|
||||
-d '[{"language_id": "Go", "repo_id": 92274475}]'
|
||||
```
|
||||
``` response
|
||||
{}
|
||||
```
|
||||
|
||||
### List hosts
|
||||
|
||||
`GET /hosts`
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ weight = 3
|
|||
nav = [
|
||||
"Starting Pilosa",
|
||||
"Sample Project",
|
||||
"Input Definition",
|
||||
"What's Next?",
|
||||
]
|
||||
+++
|
||||
|
|
@ -111,14 +110,6 @@ docker exec -it pilosa /pilosa import -i repository -f language /language.csv
|
|||
|
||||
Note that both the user IDs and the repository IDs were remapped to sequential integers in the data files, they don't correspond to actual Github IDs anymore. You can check out [languages.txt](https://github.com/pilosa/getting-started/blob/master/languages.txt) to see the mapping for languages.
|
||||
|
||||
### Input Definition
|
||||
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of v0.9.
|
||||
</div>
|
||||
|
||||
Alternatively Pilosa can import JSON data using an [Input Definition](../input-definition/) describing the schema and ETL rules to process the data.
|
||||
|
||||
#### Make Some Queries
|
||||
|
||||
<div class="note">
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
+++
|
||||
title = "Input Definition"
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
## Input Definition
|
||||
<div class="warning">
|
||||
Input definition is deprecated as of Pilosa v0.9.<br/>
|
||||
<br/>
|
||||
The previous version of this page is still available <a href="https://www.pilosa.com/docs/v0.8/input-definition">here</a>.
|
||||
</div>
|
||||
Loading…
Add table
Reference in a new issue