doc updated
This commit is contained in:
parent
8f87826b0a
commit
c9d9cafa93
10
README.md
10
README.md
@ -30,13 +30,7 @@ But unfortunately, due to the limitations of Spark's own architecture,to be us
|
||||
|
||||
### Packaging
|
||||
|
||||
**Kyuubi** server is built based on [Apache Maven](http://maven.apache.org),
|
||||
|
||||
```sbtshell
|
||||
build/mvn clean package -DskipTests
|
||||
```
|
||||
|
||||
Running the code above in the Kyuubi project directory is all we need to build a runnable Kyuubi server.
|
||||
Please refer to the [Building Kyuubi](docs/building.md) in the online documentation for an overview on how to build Kyuubi.
|
||||
|
||||
### Start Kyuubi
|
||||
|
||||
@ -94,8 +88,6 @@ Now you can use [beeline](https://cwiki.apache.org/confluence/display/Hive/HiveS
|
||||
```bash
|
||||
bin/stop-kyuubi.sh
|
||||
```
|
||||
|
||||
|
||||
**Notes:** Obviously,without the patches we supplied, Kyuubi is mostly same with the Thrift JDBC/ODBC Server as an non-mutli-tenancy server.
|
||||
|
||||
## Multi Tenancy Support
|
||||
|
||||
38
docs/building.md
Normal file
38
docs/building.md
Normal file
@ -0,0 +1,38 @@
|
||||
# Building Kyuui
|
||||
|
||||
## Building Kyuubi with Apache Maven
|
||||
**Kyuubi** server is built based on [Apache Maven](http://maven.apache.org),
|
||||
|
||||
```bash
|
||||
./build/mvn clean package -DskipTests
|
||||
```
|
||||
|
||||
Running the code above in the Kyuubi project root directory is all we need to build a runnable Kyuubi server.
|
||||
|
||||
## Building a Runnable Distribution
|
||||
|
||||
To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://github.com/yaooqinn/kyuubi/releases),
|
||||
and that is laid out so as to be runnable, use `./build/dist` in the project root directory.
|
||||
|
||||
Example:
|
||||
```bash
|
||||
./build/dist --name custom-name --tgz
|
||||
```
|
||||
|
||||
This will build a Kyuubi distribution name `kyuubi-{version}-bin-custom-name.tar.gz`. For more information on usage,
|
||||
run `./build/dist --help`
|
||||
|
||||
## Running Tests
|
||||
The following is an example of a command to run the tests:
|
||||
|
||||
```bash
|
||||
./build/mvn clean test
|
||||
```
|
||||
|
||||
With Maven, you can use the -DwildcardSuites flag to run individual Scala tests:
|
||||
|
||||
```bash
|
||||
./build/mvn -Dtest=none -DwildcardSuites=yaooqinn.kyuubi.operation.OperationTypeSuite test
|
||||
```
|
||||
|
||||
For more information about the ScalaTest Maven Plugin, refer to the [ScalaTest documentation](http://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin).
|
||||
Loading…
Reference in New Issue
Block a user