b73940861f
NOTE: Using the Oracle driver directly requires some GraalVM settings while the helidon wrapper provides those and thus works out of the box.
146 lines
5.1 KiB
Markdown
146 lines
5.1 KiB
Markdown
# Building babashka
|
|
|
|
## Prerequisites
|
|
|
|
- Install [lein](https://leiningen.org/) for producing uberjars
|
|
- Download [GraalVM](https://www.graalvm.org/downloads/). Currently we use *java11-20.1.0*.
|
|
- For Windows, installing Visual Studio 2019 with the "Desktop development
|
|
with C++" workload is recommended.
|
|
- Set `$GRAALVM_HOME` to the GraalVM distribution directory. On macOS this can look like:
|
|
|
|
``` shell
|
|
export GRAALVM_HOME=~/Downloads/graalvm-ce-java11-20.1.0/Contents/Home
|
|
```
|
|
|
|
On linux:
|
|
|
|
``` shell
|
|
export GRAALVM_HOME=~/Downloads/graalvm-ce-java11-20.1.0
|
|
```
|
|
|
|
On Windows, from the [Visual Studio 2019 x64 Native Tools Command Prompt](https://github.com/oracle/graal/issues/2116#issuecomment-590470806) or `cmd.exe` (not Powershell):
|
|
```
|
|
set GRAALVM_HOME=%USERPROFILE%\Downloads\graalvm-ce-java11-20.1.0
|
|
```
|
|
If you are not running from the x64 Native Tools Command Prompt, you will need to set additional environment variables using:
|
|
```
|
|
call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
|
|
```
|
|
|
|
## Clone repository
|
|
|
|
NOTE: the babashka repository contains submodules. You need to use the
|
|
`--recursive` flag to clone these submodules along with the main repo.
|
|
|
|
``` shellsession
|
|
$ git clone https://github.com/borkdude/babashka --recursive
|
|
```
|
|
|
|
To update later on:
|
|
|
|
``` shellsession
|
|
$ git submodule update --recursive
|
|
```
|
|
|
|
## Build
|
|
|
|
Run the `uberjar` and `compile` script:
|
|
|
|
``` shell
|
|
$ script/uberjar
|
|
$ script/compile
|
|
```
|
|
|
|
To configure max heap size you can use:
|
|
|
|
```
|
|
$ export BABASHKA_XMX="-J-Xmx6500m"
|
|
```
|
|
|
|
Note: setting the max heap size to a low value can cause the build to crash or
|
|
take long to complete.
|
|
|
|
## Windows
|
|
|
|
Run `script\uberjar.bat` followed by `script\compile.bat`.
|
|
|
|
## Feature flags
|
|
|
|
Babashka supports the following feature flags:
|
|
|
|
| Name | Description | Default |
|
|
|--------|----------------------------------------------|----------|
|
|
| `BABASHKA_FEATURE_CORE_ASYNC` | Includes the [clojure.core.async](https://github.com/clojure/core.async) library | `true` |
|
|
| `BABASHKA_FEATURE_CSV` | Includes the [clojure.data.csv](https://github.com/clojure/data.csv) library | `true` |
|
|
| `BABASHKA_FEATURE_JAVA_NIO` | Includes commonly used classes from the `java.nio` package | `true` |
|
|
| `BABASHKA_FEATURE_JAVA_TIME` | Includes commonly used classes from the `java.time` package | `true` |
|
|
| `BABASHKA_FEATURE_TRANSIT` | Includes the [transit-clj](https://github.com/cognitect/transit-clj) library | `true` |
|
|
| `BABASHKA_FEATURE_XML` | Includes the [clojure.data.xml](https://github.com/clojure/data.xml) library | `true` |
|
|
| `BABASHKA_FEATURE_YAML` | Includes the [clj-yaml](https://github.com/clj-commons/clj-yaml) library | `true` |
|
|
| `BABASHKA_FEATURE_HTTPKIT_CLIENT` | Includes the [http-kit](https://github.com/http-kit/http-kit) client library | `true` |
|
|
| `BABASHKA_FEATURE_HTTPKIT_SERVER` | Includes the [http-kit](https://github.com/http-kit/http-kit) server library | `true` |
|
|
| `BABASHKA_FEATURE_JDBC` | Includes the [next.jdbc](https://github.com/seancorfield/next-jdbc) library | `false` |
|
|
| `BABASHKA_FEATURE_POSTGRESQL` | Includes the [PostgresSQL](https://jdbc.postgresql.org/) JDBC driver | `false` |
|
|
| `BABASHKA_FEATURE_HSQLDB` | Includes the [HSQLDB](http://www.hsqldb.org/) JDBC driver | `false` |
|
|
| `BABASHKA_FEATURE_ORACLEDB` | Includes the [Oracle](https://www.oracle.com/database/technologies/appdev/jdbc.html) JDBC driver | `false` |
|
|
| `BABASHKA_FEATURE_DATASCRIPT` | Includes [datascript](https://github.com/tonsky/datascript) | `false` |
|
|
| `BABASHKA_FEATURE_LANTERNA` | Includes [clojure-lanterna](https://github.com/babashka/clojure-lanterna) | `false` |
|
|
|
|
Note that httpkit server is currently experimental, the feature flag could be toggled to `false` in a future release.
|
|
|
|
To disable all of the above features, you can set `BABASHKA_LEAN` to `true`.
|
|
|
|
Here is an [example
|
|
commit](https://github.com/borkdude/babashka/commit/13f65f05aeff891678e88965d9fbd146bfa87f4e)
|
|
that can be used as a checklist when you want to create a new feature flag.
|
|
|
|
### HyperSQL
|
|
|
|
To compile babashka with the `next.jdbc` library and the embedded HyperSQL
|
|
database:
|
|
|
|
``` shell
|
|
$ export BABASHKA_FEATURE_JDBC=true
|
|
$ export BABASHKA_FEATURE_HSQLDB=true
|
|
$ script/uberjar
|
|
$ script/compile
|
|
```
|
|
|
|
Note: there is now a [pod](https://github.com/babashka/babashka-sql-pods) for working with HyperSQL.
|
|
|
|
### PostgresQL
|
|
|
|
To compile babashka with the `next.jdbc` library and a PostgresQL driver:
|
|
|
|
``` shell
|
|
$ export BABASHKA_FEATURE_JDBC=true
|
|
$ export BABASHKA_FEATURE_POSTGRESQL=true
|
|
$ script/uberjar
|
|
$ script/compile
|
|
```
|
|
|
|
Note: there is now a [pod](https://github.com/babashka/babashka-sql-pods) for working with PostgreSQL.
|
|
|
|
### Lanterna
|
|
|
|
To compile babashka with the [babashka/clojure-lanterna](https://github.com/babashka/clojure-lanterna) library:
|
|
|
|
``` shell
|
|
$ export BABASHKA_FEATURE_LANTERNA=true
|
|
$ script/uberjar
|
|
$ script/compile
|
|
```
|
|
|
|
Example program:
|
|
|
|
``` clojure
|
|
(require '[lanterna.terminal :as terminal])
|
|
|
|
(def terminal (terminal/get-terminal))
|
|
|
|
(terminal/start terminal)
|
|
(terminal/put-string terminal "Hello TUI Babashka!" 10 5)
|
|
(terminal/flush terminal)
|
|
|
|
(read-line)
|
|
```
|