yosql-website/content/configuration/files/outputBaseDirectory.md

   1 ---
   2 title: outputBaseDirectory
   3 date: 2019-09-27T18:51:08+02:00
   4 menu:
   5   main:
   6     parent: Files
   7 categories:
   8   - Configuration
   9 tags:
  10   - files
  11   - directories
  12   - output
  13 ---
  14
  15 Controls the root directory `YoSQL` will use to output generated Java code.
  16
  17 ## Configuration Options
  18
  19 ### Option: '.'
  20
  21 The default value of the `outputBaseDirectory` configuration option is `.` - the current directory. Note that tooling may change the default output base directory to better reflect a typical project structure used with such a tool.
  22
  23 ### Option: 'some/other/directory'
  24
  25 Changing the `outputBaseDirectory` configuration option to `some/other/directory!` configures `YoSQL` to write into the relative directory`some/other/directory`.
  26
  27 ### Option: '/an/absolute/path'
  28
  29 Changing the `outputBaseDirectory` configuration option to `/an/absolute/path!` configures `YoSQL` to write into the absolute directory path `/an/absolute/path`.
  30
  31 ## Related Options
  32
  33 - [inputBaseDirectory](../inputbasedirectory/): Controls the input directory for `.sql` files.
  34
  35 ## Tooling
  36
  37 ### Maven
  38
  39 In order to use `YoSQL` together with [Maven](https://maven.apache.org/), take a look at the tooling [documentation for Maven](/tooling/maven/). By default, the Maven tooling with set `outputBaseDirectory` to `target/generated-sources/yosql`.
  40
  41 {{< maven/config/files/outputBaseDirectory >}}
  42
  43 ### Gradle
  44
  45 In order to use `YoSQL` together with [Gradle](https://gradle.org/), take a look at the tooling [documentation for Gradle](/tooling/gradle/). By default, the Gradle tooling with set `outputBaseDirectory` to `build/generated/sources/yosql`.
  46
  47 ```kotlin
  48 plugins {
  49   java
  50   id("wtf.metio.yosql") version "1.2.3"
  51 }
  52
  53 yosql {
  54   files {
  55     outputBaseDirectory = file("build/generated-sources/yosql")
  56   }
  57 }
  58 ```
  59
  60 ### Bazel
  61
  62 In order to use `YoSQL` together with [Bazel](https://bazel.build/), take a look at the tooling [documentation for Bazel](/tooling/bazel/).
  63
  64 ### CLI
  65
  66 In order to use YoSQL on the command line, take a look at the tooling [documentation for CLI](/tooling/cli/).
  67
  68 ```shell
  69 $ yosql --files-output-base-directory=generated-sources/yosql
  70 ```
  71
  72 The shorter form is available as well:
  73
  74 ```shell
  75 $ yosql --output-base-directory=generated-sources/yosql
  76 ```