featurebase/docs/webui.md
2018-07-05 14:52:30 -05:00

1.7 KiB

+++ title = "WebUI" weight = 9 nav = [ "Console", "Cluster Admin", ] +++

WebUI

A web-based app called Pilosa WebUI is available in a separate package. This can be used for constructing queries and viewing the cluster status.

Installation

Releases are available on Github as well as on Homebrew for Mac.

Installing on a Mac with Homebrew is simple; just run:

brew install pilosa-webui

You may also build from source by checking out the repo on Github and running:

make install

Console

The Console view allows you to enter PQL 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.

webUI console screenshot WebUI console 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.

  • :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.