Name Date Size

..19-Aug-20204 KiB

.gitignoreH A D19-Aug-202033

CMakeLists.standalone.txtH A D19-Aug-20201.4 KiB

CMakeLists.txtH A D19-Aug-2020963

launch-cbq-gui.batH A D19-Aug-20201.5 KiB

launch-cbq-gui.shH A D19-Aug-20201.4 KiB

LICENSE.txtH A D19-Aug-20202.4 KiB

pluggable-ui-query.json.inH A D19-Aug-2020237

query-ui/H19-Aug-20204 KiB

README.license.txtH A D19-Aug-20201.6 KiB

README.mdH A D19-Aug-20202.5 KiB

ui_server.goH A D19-Aug-202018.6 KiB

README.license.txt

1Here is a list of open source code used in the query workbench:
2
3UUID generator:
4    /**
5     * Fast UUID generator, RFC4122 version 4 compliant.
6     * @author Jeff Ward (jcward.com).
7     * @license MIT license
8     * @link http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/21963136#21963136
9     * The source code is not on github. It can be found here: http://jcward.com/UUID.js
10     **/
11
12Table Sorting
13    Code: http://www.kryogenix.org/code/browser/sorttable/sorttable.js
14    License:  From the code: "Licensed as X11:
15    http://www.kryogenix.org/code/browser/licence.html 
16    This basically means: do what you want with it."
17
18ACE Code Editor
19    Code: https://github.com/ajaxorg/ace
20    Copyright & License (BSD):
21    Copyright (c) 2010, Ajax.org B.
22    
23lodash
24    Copyright jQuery Foundation and other contributors
25    https://github.com/lodash/lodash/blob/master/LICENSE
26    
27angular.js
28    The MIT License Copyright (c)
29    https://github.com/angular/angular.js/blob/master/LICENSE
30    
31ui-router
32    The MIT License Copyright (c) 2013-2015
33    https://github.com/angular-ui/ui-router/blob/master/LICENSE
34    
35FileSaver.js
36    Copyright © 2015 Eli Grey
37    https://github.com/eligrey/FileSaver.js/blob/master/LICENSE.md
38    
39Blob.js
40    Copyright © 2014 Eli Grey
41    https://github.com/eligrey/Blob.js/blob/master/LICENSE.md
42    
43angular-ui-tree
44    The MIT License (MIT) Copyright (c) 2014
45    https://github.com/angular-ui-tree/angular-ui-tree/blob/master/LICENSE
46    
47jquery
48    Copyright (c) jQuery Foundation, Inc. and Contributors, All Rights Reserved.
49    https://github.com/jquery/esprima/blob/master/LICENSE.BSD
50    
51

README.md

1# query-ui
2
3This repository contains the resources used for the Couchbase Query Workbench,
4which is a plug-in for the Couchbase Administrative Console. This code can also 
5be run in a stand-alone mode, for users who are not administrators. This document 
6primarily describes the latter use, in stand-alone mode.
7
8## Steps to create a build
9
10You will need to have golang installed on your platform.
11
12### Get a working repository
13
14     $ mkdir $HOME/standalone
15     $ export GOPATH=$HOME/standalone
16     $ mkdir -p $GOPATH/src/github.com/couchbase/
17     $ cd $HOME/standalone
18     $ mkdir bin pkg
19
20Clone the git repo into the current working directory, to get the
21source, so as to be able to make a build. This clones it into query:
22
23     $ cd $GOPATH/src/github.com/couchbase/
24     $ git clone ssh://github.com/couchbase/query-ui query-ui
25     $ cd query-ui
26     $ go get .
27     $ cd $GOPATH
28     $ go install -v -gcflags "-N -l" ./src/github.com/couchbase/query-ui
29
30This creates an executable called 'query-ui' in the $GOPATH/bin directory.
31
32## Running the tool with Couchbase
33
34To run in standalone mode, you need to tell the executable where to find a
35Couchbase server, and where to find all the web resources.
36
37    $GOPATH/bin/query-ui -webcontent=$GOPATH/src/github.com/couchbase/query-ui/ -datastore=http://localhost:8091
38    
39which should produce the following output messages:
40    
41    Launching query web service.
42    Using CB Server at: http://localhost:8091
43    Using N1QL query service on: localhost:8093
44    Using mgmt query service on: localhost:8091
45    Using web content at: /Users/eben/src/standalone/src/github.com/couchbase/query-ui/query-ui
46    Launching UI server, to use, point browser at http://localhost:8095
47
48If you want to have it use a specific query engine, you can specify that instead:
49
50    $GOPATH/bin/query-ui -webcontent=$GOPATH/src/github.com/couchbase/query-ui/ -queryEngine=http://localhost:8093
51    
52The UI will be accessible via a web browser, by default on http://localhost:8095.
53
54The UI is the same as is found in the Couchbase administrative console.
55
56
57## Running the tool with CBAS
58
59This UI can also run against an instance of CBAS, where you give it the URL for CBAS as the -queryengine, and tell it the REST prefix to use instead of /query:
60
61    $GOPATH/bin/query-ui -webcontent=$GOPATH/src/github.com/couchbase/query-ui/ -queryEngine=http://localhost:8095 -queryPrefix=/analytics -localPort=:8096
62    
63Because CBAS defaults to port 8095 as well, you need to tell it to put the UI on a different port, in this example 8096.    
64
65