mkdocs.yml

site_name: ts-sql-query
site_description: Type-safe SQL query builder for TypeScript.
# Required for a non-empty sitemap.xml and <link rel="canonical"> tags.
# On Read the Docs this resolves per-version (e.g. .../en/latest/) via READTHEDOCS_CANONICAL_URL;
# the fallback is used for local builds.
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://ts-sql-query.readthedocs.io/']
repo_url: https://github.com/juanluispaz/ts-sql-query
repo_name: juanluispaz/ts-sql-query
# Theme overrides live under docs/overrides (theme.custom_dir); exclude them from the built site.
exclude_docs: |
  overrides/
copyright: >
    Copyright &copy; Juan Luis Paz Rojas
    <span style="color: var(--md-footer-fg-color--lighter);"> · Released under the </span><a href="https://opensource.org/licenses/MIT" target="_blank">MIT License</a>.
    <span style="color: var(--md-footer-fg-color--lighter);"> · </span><a href="#__consent">Change cookie settings</a>
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://www.github.com/juanluispaz
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/juanluispaz/en
  analytics:
    provider: google
    property: G-P1JM246C1P
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            <a href="https://github.com/juanluispaz/ts-sql-query/issues/new/?labels=documentation&title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">opening an issue on GitHub</a>
            and telling us what was missing, unclear, or could be better.
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - reject
      - manage
plugins:
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#+search.separator + ' (escaped as '') + \- moved at the end of group, added +*<>@{}
  - search:
      separator: '[\s,:!=\[\]()"\''/\-+*<>@{}]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
theme:
  name: material
  custom_dir: docs/overrides
  language: en
  icon:
    logo: material/shield-half-full
    repo: fontawesome/brands/github
  favicon: logo.svg
  features:
    - navigation.expand
    - toc.integrate
    - navigation.tabs
    - navigation.footer
    - search.highlight
    - content.tabs.link
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: teal
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
extra_css:
  - extra.css
extra_javascript:
  - js/version-switcher.js
markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
      extend_pygments_lang:
        - name: typescriptreact
          lang: tsx
        - name: mariadb
          lang: mysql
        - name: mysql
          lang: mysql
        - name: oracle
          lang: plpgsql
        - name: postgresql
          lang: plpgsql
        - name: sqlite
          lang: plpgsql
        - name: sqlserver
          lang: tsql
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
nav:
  - Home: index.md
  - Queries:
    - Basic query structure: queries/basic-query-structure.md
    - Select: queries/select.md
    - Select page: queries/select-page.md
    - Recursive select: queries/recursive-select.md
    - Complex projections: queries/complex-projections.md
    - Aggregate as an object array: queries/aggregate-as-object-array.md
    - Insert: queries/insert.md
    - Update: queries/update.md
    - Delete: queries/delete.md
    - Transaction: queries/transaction.md
    - Dynamic queries: queries/dynamic-queries.md
    - Extreme dynamic queries: queries/extreme-dynamic-queries.md
    - SQL Fragments: queries/sql-fragments.md
  - Configuration:
    - Connection: configuration/connection.md
    - Mapping: configuration/mapping.md
    - Column types: configuration/column-types.md
    - Time zones: configuration/time-zones.md
    - Collations: configuration/collations.md
    - Supported databases:
      - MariaDB: configuration/supported-databases/mariadb.md
      - MySQL: configuration/supported-databases/mysql.md
      - Oracle: configuration/supported-databases/oracle.md
      - PostgreSQL: configuration/supported-databases/postgresql.md
      - SQLite: configuration/supported-databases/sqlite.md
      - SQL Server: configuration/supported-databases/sqlserver.md
    - Recommended query runners: 
      - better-sqlite3: configuration/query-runners/recommended/better-sqlite3.md
      - mariadb: configuration/query-runners/recommended/mariadb.md
      - mssql: configuration/query-runners/recommended/mssql.md
      - "node:sqlite": configuration/query-runners/recommended/node_sqlite.md
      - mysql2: configuration/query-runners/recommended/mysql2.md
      - oracledb: configuration/query-runners/recommended/oracledb.md
      - pg: configuration/query-runners/recommended/pg.md
      - postgres: configuration/query-runners/recommended/postgres.md
      - pglite: configuration/query-runners/recommended/pglite.md
      - sqlite-wasm OO1: configuration/query-runners/recommended/sqlite-wasm-OO1.md
    - Bun's recommended query runners:
      - Bun Sqlite: configuration/query-runners/recommended/bun_sqlite.md
      - Bun SQL for MySQL: configuration/query-runners/recommended/bun_sql_mysql.md
      - Bun SQL for SQLite: configuration/query-runners/recommended/bun_sql_sqlite.md
      - Bun SQL for PostgreSQL: configuration/query-runners/recommended/bun_sql_postgres.md
    - General purpose query runners:
      - InterceptorQueryRunner: configuration/query-runners/general-purpose/InterceptorQueryRunner.md
      - LoggingQueryRunner: configuration/query-runners/general-purpose/LoggingQueryRunner.md
      - MockQueryRunner: configuration/query-runners/general-purpose/MockQueryRunner.md
      - Others:
        - ConsoleLogQueryRunner: configuration/query-runners/general-purpose/ConsoleLogQueryRunner.md
        - ConsoleLogNoopQueryRunner: configuration/query-runners/general-purpose/ConsoleLogNoopQueryRunner.md
        - NoopQueryRunner: configuration/query-runners/general-purpose/NoopQueryRunner.md
    - Additional query runners:
      - prisma: configuration/query-runners/additional/prisma.md
      - sqlite3: configuration/query-runners/additional/sqlite3.md
  - API: 
    - API Introduction: api/introduction.md
    - Connection API: api/connection.md
    - Table API: api/table.md
    - View API: api/view.md
    - Constant values view API: api/constant-values-view.md
    - Value expressions API: api/value-expressions.md
    - Select API: api/select.md
    - Insert API: api/insert.md
    - Update API: api/update.md
    - Delete API: api/delete.md
    - Type adpaters API: api/type-adpaters.md
    - Dynamic conditions API: api/dynamic-conditions.md
    - Error Management:
      - Overview: api/error-management/overview.md
      - Error types: api/error-management/error-types.md
      - TypeScript types: api/error-management/typescript-types.md
      - Library-raised errors: api/error-management/library-raised-errors.md
      - Native database mappings:
        - MariaDB: api/error-management/native-mappings/mariadb.md
        - MySQL: api/error-management/native-mappings/mysql.md
        - Oracle: api/error-management/native-mappings/oracle.md
        - PostgreSQL: api/error-management/native-mappings/postgresql.md
        - SQLite: api/error-management/native-mappings/sqlite.md
        - SQL Server: api/error-management/native-mappings/sql-server.md
  - Dynamic:
    - Dynamic query building blocks: dynamic/building-blocks.md
    - Booleans and three-valued logic: dynamic/three-valued-booleans.md
    - Dynamic queries from a business model: dynamic/from-business-model.md
    - Dynamic queries from the database types: dynamic/from-database-types.md
    - Utilities:
      - Dynamic conditions: dynamic/utilities/conditions.md
      - Dynamic picks: dynamic/utilities/picks.md
      - Dynamic order by: dynamic/utilities/order-by.md
  - Advanced:
    - Custom booleans values: advanced/custom-booleans-values.md
    - Synchronous query runners: advanced/synchronous-query-runners.md
    - ID manipulation: advanced/id-manipulation.md
    - Extract columns from an object: advanced/columns-from-object.md
    - Utility types: advanced/utility-types.md
    - Deep utilities: advanced/deep-utilities.md
    - Passing tables and views as parameter: advanced/tables-views-as-parameter.md
    - Query execution metadata: advanced/query-execution-metadata.md
  - Keywords:
    - Select Keywords: keywords/select.md
    - Insert Keywords: keywords/insert.md
    - Update Keywords: keywords/update.md
    - Delete Keywords: keywords/delete.md
    - Function and Operator Keywords: keywords/functions-oprators.md
    - Transaction Keywords: keywords/transaction.md
  - About:
    - Philosophy and Design Goals: about/philosophy.md
    - FAQs: about/faqs.md
    - Limitations: about/limitations.md
    - Examples: about/examples.md
    - Change Log: CHANGELOG.md