Reference
ReferenceEvery module’s interface, generated by odoc from its .mli, where each
function says what it does, what it refuses and what it defaults to.
The packages
Section titled “The packages”Each package is separate, so a program links only what it uses. A dune
file names a library as it is installed (rowtype-postgres); OCaml code
names it as a module (Rowtype_postgres).
| Package | Libraries | What it is |
|---|---|---|
rowtype |
rowtype |
Queries described once; links no database library |
rowtype-postgres |
rowtype-postgres |
The Postgres backend, over postgres-eio |
rowtype-sqlite |
rowtype-sqlite |
The SQLite backend, over the sqlite3 binding |
rowtype-migrate |
rowtype-migrate, rowtype-migrate.postgres, rowtype-migrate.sqlite |
The migrations and the rowtype-migrate command, for each dialect installed beside it |
rowtype
Section titled “rowtype”Rowtype– shapes, statements, errors, and the signature a backend fills.Rowtype_postgres– connections, the pool, notifications, transactions,COPYandverifyon Postgres. Its parts:Pool,ListenerandTransaction.Rowtype_sqlite– connections, the pool, transactions, the load andverifyon SQLite. Its parts:PoolandTransaction.Rowtype_migrate– the files, the record and its rules, the same for every dialect.Rowtype_migrate_postgres– migrating Postgres.Rowtype_migrate_sqlite– migrating SQLite.
What it is built on
Section titled “What it is built on”Postgres_eio– the driver underrowtype-postgres, whose connection strings, pool and listener it passes through.
