_pkgdown.yml

url: https://dbi.r-dbi.org

template:
  package: dbitemplate
  bootstrap: 5

home:
  links:
  - text: Report a security vulnerability
    href: https://dbi.r-dbi.org/security.html
  - text: DBI project website
    href: https://r-dbi.org

reference:
- title: Connecting and disconnecting
  desc: Connecting to and disconnecting from databases.
  contents:
  - dbConnect
  - dbDisconnect
  - dbCanConnect
  - dbGetInfo
  - dbIsValid
  - dbIsReadOnly
  - DBIConnector-class
  - dbGetConnectArgs

- title: Tables
  desc: Reading and writing entire tables.
  contents:
  - dbReadTable
  - dbWriteTable
  - dbCreateTable
  - dbAppendTable
  - dbRemoveTable
  - dbListTables
  - dbListFields
  - dbExistsTable
  - dbListObjects
  - rownames

- title: Queries and statements
  desc: Communicate with the DBMS.
  contents:
  - dbGetQuery
  - dbExecute

- title: Results
  desc: More control for sending queries and executing statements.
  contents:
  - dbSendQuery
  - dbSendStatement
  - dbBind
  - dbFetch
  - dbGetRowCount
  - dbGetRowsAffected
  - dbGetStatement
  - dbHasCompleted
  - dbColumnInfo
  - dbClearResult

- title: Transactions
  desc: Ensuring multiple statements are executed together, or not at all.
  contents:
  - transactions
  - dbWithTransaction

- title: SQL
  desc: Tools for creating and parsing SQL queries.
  contents:
  - SQL
  - dbDataType
  - dbQuoteIdentifier
  - dbQuoteLiteral
  - dbQuoteString
  - sqlCreateTable
  - sqlAppendTable
  - sqlData
  - dbUnquoteIdentifier
  - sqlInterpolate

- title: Arrow
  desc: >
    <p><a href="https://lifecycle.r-lib.org/articles/stages.html">
      <img src="figures/lifecycle-experimental.svg" alt="Experimental lifecycle"/>
    </a></p>

    Returning and sending data in the Arrow format.
  contents:
  - dbReadTableArrow
  - dbWriteTableArrow
  - dbCreateTableArrow
  - dbAppendTableArrow
  - dbGetQueryArrow
  - dbSendQueryArrow
  - dbBindArrow
  - dbFetchArrow
  - dbFetchArrowChunk

- title: Classes
  desc: S4 classes defined by DBI.
  contents:
  - DBI-package
  - DBIObject-class
  - DBIDriver-class
  - DBIConnection-class
  - DBIResult-class
  - DBIResultArrow-class
  - DBIConnector-class
  - Id-class

- title: Data
  desc: S4 classes defined by DBI.
  contents:
  - .SQL92Keywords

articles:
- title: Tutorials
  contents:
  - DBI
  - DBI-advanced
  - DBI-arrow
  - backend
- title: Specification
  contents:
  - spec
- title: Historic
  contents:
  - DBI-proposal
  - DBI-history
  - DBI-1

development:
  mode: auto

authors:
  Kirill Müller:
    href: https://krlmlr.info

news:
  cran_dates: false