yosql-website/content/sql/sql-files.md

   1 ---
   2 title: SQL Files
   3 date: 2019-07-07T14:27:54+02:00
   4 menu:
   5   main:
   6     parent: SQL
   7 categories:
   8   - SQL
   9 tags:
  10   - sql
  11   - files
  12 ---
  13
  14 There are some restrictions on what counts as a `.sql` file for `YoSQL`.
  15
  16 ## Naming
  17
  18 In order to correctly guess which type (reading/writing/calling) your statement is, `YoSQL` does not parse your SQL code, but uses the file name of your `.sql` files or the `name` [front matter](../frontmatter/). It applies the following rules to determine the type of a statement from its name:
  19
  20 - All names that start with the [configured read prefixes](/configuration/repositories/allowedreadprefixes/) are assigned the `READING` type.
  21 - All names that start with the [configured write prefixes](/configuration/repositories/allowedwriteprefixes/) are assigned the `WRITING` type.
  22 - All names that start with the [configured call prefixes](/configuration/repositories/allowedcallprefixes/) are assigned the `CALLING` type.
  23 - All other statements are assigned the `UNKNOWN` type. **Statements of this type are ignored while generating code.**
  24
  25 You can always overwrite that guess with a specific `type` value in your [front matter](../frontmatter/). This can be useful if you want to use a special name for your statement, but don't want to adhere to the configured prefixes. On the other hand, enable [validateMethodNamePrefixes](/configuration/repositories/validatemethodnameprefixes/) to enforce that all statements are named accordingly to the configured prefixes.
  26
  27 ## File Extension
  28
  29 By default, `YoSQL` only considers files that end in `.sql`, but this can be configured using the [sqlFilesSuffix](/configuration/files/sqlfilessuffix) option.
  30
  31 ## File Charset
  32
  33 By default, `YoSQL` uses the **UTF-8** charset. In order to change this, use the [sqlFilesCharset](/configuration/files/sqlfilescharset) option.
  34
  35 ## Statement Separator
  36
  37 By default, `YoSQL` uses `;` to separate multiple SQL statements within a single file. In order to change this, use the [sqlStatementSeparator](/configuration/files/sqlstatementseparator) option.
  38
  39 ## License Headers
  40
  41 In case your `.sql` files contain a license header, use the [skipLines](/configuration/files/skiplines) option to skip those initial lines. Otherwise `YoSQL` will consider those lines to be part of the first statement in your `.sql` file.