mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-08-28 10:54:59 +00:00
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
+++
|
|
title = "Console"
|
|
weight = 9
|
|
nav = [
|
|
"Installation",
|
|
"Query",
|
|
"Cluster Admin",
|
|
]
|
|
+++
|
|
|
|
## Console
|
|
|
|
A web-based app called Pilosa Console is available in a separate package. This can be used for constructing queries and viewing the cluster status.
|
|
|
|
### Installation
|
|
|
|
Releases are [available on Github](https://github.com/pilosa/console/releases) as well as on [Homebrew](https://brew.sh/) for Mac.
|
|
|
|
Installing on a Mac with Homebrew is simple; just run:
|
|
|
|
```
|
|
brew tap pilosa/homebrew-pilosa
|
|
brew install pilosa-console
|
|
```
|
|
|
|
You may also build from source by checking out the [repo on Github](https://github.com/pilosa/console) and running:
|
|
|
|
```
|
|
make install
|
|
```
|
|
|
|
### Query
|
|
|
|
The Query tab allows you to enter [PQL](../query-language/) queries and run them against your locally running server. First you must select an Index with the Select index dropdown.
|
|
|
|
Each query's result will be displayed in the Output section along with the query time.
|
|
|
|
The Console will keep a record of each query and its result with the latest query on top.
|
|
|
|
|
|
*Console query screenshot*
|
|
|
|
In addition to standard PQL, the console supports a few special commands, prefixed with `:`.
|
|
|
|
- `:create index <indexname>`
|
|
- `:delete index <indexname>`
|
|
- `:use <indexname>`
|
|
- `:create field <fieldname>`
|
|
- `:delete field <fieldname>`
|
|
|
|
Field creation also supports options like `timeQuantum`. When creating a new field, add options by using the keys documented in [API reference](../api-reference/#create-field).
|
|
|
|
- `:create field <fieldname> cacheSize=10000`
|
|
|
|
|
|
### Cluster Admin
|
|
|
|
Use the Cluster Admin tab to view the current status of your cluster. This contains information on each node in the cluster, plus the list of Indexes and Fields.
|