4 Commits
2.0.0 ... 2.2.0

Author SHA1 Message Date
fb74d84cb7 Map names to db ident names for columns passed for ordering in paginated queries. 2023-08-09 09:16:10 -05:00
fbd20de71f Add createOrUpdateRecord and record method generators.
`createOrUpdateRecord` implements upsert: update an existing record if
it exists or create a new record if not. A new error `DbUpdateError` was
added to be raised when an existing record does exist but was not able
to be updated.
2023-08-09 09:13:12 -05:00
540d0d2f67 Fix missing import in pooling implementation. 2023-02-04 19:04:50 -06:00
a05555ee67 WIP - Initial stab at making it generic to support db_sqlite. 2022-11-03 16:38:14 -05:00
5 changed files with 185 additions and 85 deletions

View File

@ -1,6 +1,6 @@
# Package # Package
version = "2.0.0" version = "2.2.0"
author = "Jonathan Bernard" author = "Jonathan Bernard"
description = "Lightweight Postgres ORM for Nim." description = "Lightweight Postgres ORM for Nim."
license = "GPL-3.0" license = "GPL-3.0"
@ -11,4 +11,4 @@ srcDir = "src"
# Dependencies # Dependencies
requires @["nim >= 1.4.0", "uuids"] requires @["nim >= 1.4.0", "uuids"]
requires "https://git.jdb-software.com/jdb/nim-namespaced-logging.git" requires "namespaced_logging >= 0.3.0"

View File

@ -107,6 +107,7 @@
## ##
## proc createTodoItem*(db: TodoDB, rec: TodoItem): TodoItem; ## proc createTodoItem*(db: TodoDB, rec: TodoItem): TodoItem;
## proc updateTodoItem*(db: TodoDB, rec: TodoItem): bool; ## proc updateTodoItem*(db: TodoDB, rec: TodoItem): bool;
## proc createOrUpdateTodoItem*(db: TodoDB, rec: TodoItem): bool;
## proc deleteTodoItem*(db: TodoDB, rec: TodoItem): bool; ## proc deleteTodoItem*(db: TodoDB, rec: TodoItem): bool;
## proc deleteTodoItem*(db: TodoDB, id: UUID): bool; ## proc deleteTodoItem*(db: TodoDB, id: UUID): bool;
## ##
@ -282,11 +283,12 @@
## ##
## .. _pool.DbConnPool: fiber_orm/pool.html#DbConnPool ## .. _pool.DbConnPool: fiber_orm/pool.html#DbConnPool
## ##
import std/db_postgres, std/macros, std/options, std/sequtils, std/strutils import std/[db_common, logging, macros, options, sequtils, strutils]
import namespaced_logging, uuids import namespaced_logging, uuids
from std/unicode import capitalize from std/unicode import capitalize
import ./fiber_orm/db_common as fiber_db_common
import ./fiber_orm/pool import ./fiber_orm/pool
import ./fiber_orm/util import ./fiber_orm/util
@ -311,13 +313,16 @@ type
records*: seq[T] records*: seq[T]
totalRecords*: int totalRecords*: int
DbUpdateError* = object of CatchableError ##\
## Error types raised when a DB modification fails.
NotFoundError* = object of CatchableError ##\ NotFoundError* = object of CatchableError ##\
## Error type raised when no record matches a given ID ## Error type raised when no record matches a given ID
var logNs {.threadvar.}: LoggingNamespace var logNs {.threadvar.}: LoggingNamespace
template log(): untyped = template log(): untyped =
if logNs.isNil: logNs = initLoggingNamespace(name = "fiber_orm", level = lvlNotice) if logNs.isNil: logNs = getLoggerForNamespace(namespace = "fiber_orm", level = lvlNotice)
logNs logNs
proc newMutateClauses(): MutateClauses = proc newMutateClauses(): MutateClauses =
@ -326,7 +331,7 @@ proc newMutateClauses(): MutateClauses =
placeholders: @[], placeholders: @[],
values: @[]) values: @[])
proc createRecord*[T](db: DbConn, rec: T): T = proc createRecord*[D: DbConnType, T](db: D, rec: T): T =
## Create a new record. `rec` is expected to be a `model class`_. The `id` ## Create a new record. `rec` is expected to be a `model class`_. The `id`
## field is only set if it is non-empty (see `ID Field`_ for details). ## field is only set if it is non-empty (see `ID Field`_ for details).
## ##
@ -349,7 +354,7 @@ proc createRecord*[T](db: DbConn, rec: T): T =
result = rowToModel(T, newRow) result = rowToModel(T, newRow)
proc updateRecord*[T](db: DbConn, rec: T): bool = proc updateRecord*[D: DbConnType, T](db: D, rec: T): bool =
## Update a record by id. `rec` is expected to be a `model class`_. ## Update a record by id. `rec` is expected to be a `model class`_.
var mc = newMutateClauses() var mc = newMutateClauses()
populateMutateClauses(rec, false, mc) populateMutateClauses(rec, false, mc)
@ -365,13 +370,31 @@ proc updateRecord*[T](db: DbConn, rec: T): bool =
return numRowsUpdated > 0; return numRowsUpdated > 0;
template deleteRecord*(db: DbConn, modelType: type, id: typed): untyped = proc createOrUpdateRecord*[D: DbConnType, T](db: D, rec: T): T =
## Create or update a record. `rec` is expected to be a `model class`_. If
## the `id` field is unset, or if there is no existing record with the given
## id, a new record is inserted. Otherwise, the existing record is updated.
##
## Note that this does not perform partial updates, all fields are updated.
let findRecordStmt = "SELECT id FROM " & tableName(rec) & " WHERE id = ?"
log().debug "createOrUpdateRecord: [" & findRecordStmt & "] id: " & $rec.id
let rows = db.getAllRows(sql(findRecordStmt), [$rec.id])
if rows.len == 0: result = createRecord(db, rec)
else:
result = rec
if not updateRecord(db, rec):
raise newException(DbUpdateError,
"unable to update " & modelName(rec) & " for id " & $rec.id)
template deleteRecord*[D: DbConnType](db: D, modelType: type, id: typed): untyped =
## Delete a record by id. ## Delete a record by id.
let sqlStmt = "DELETE FROM " & tableName(modelType) & " WHERE id = ?" let sqlStmt = "DELETE FROM " & tableName(modelType) & " WHERE id = ?"
log().debug "deleteRecord: [" & sqlStmt & "] id: " & $id log().debug "deleteRecord: [" & sqlStmt & "] id: " & $id
db.tryExec(sql(sqlStmt), $id) db.tryExec(sql(sqlStmt), $id)
proc deleteRecord*[T](db: DbConn, rec: T): bool = proc deleteRecord*[D: DbConnType, T](db: D, rec: T): bool =
## Delete a record by `id`_. ## Delete a record by `id`_.
## ##
## .. _id: #model-class-id-field ## .. _id: #model-class-id-field
@ -379,7 +402,7 @@ proc deleteRecord*[T](db: DbConn, rec: T): bool =
log().debug "deleteRecord: [" & sqlStmt & "] id: " & $rec.id log().debug "deleteRecord: [" & sqlStmt & "] id: " & $rec.id
return db.tryExec(sql(sqlStmt), $rec.id) return db.tryExec(sql(sqlStmt), $rec.id)
template getRecord*(db: DbConn, modelType: type, id: typed): untyped = template getRecord*[D: DbConnType](db: D, modelType: type, id: typed): untyped =
## Fetch a record by id. ## Fetch a record by id.
let sqlStmt = let sqlStmt =
"SELECT " & columnNamesForModel(modelType).join(",") & "SELECT " & columnNamesForModel(modelType).join(",") &
@ -394,8 +417,8 @@ template getRecord*(db: DbConn, modelType: type, id: typed): untyped =
rowToModel(modelType, row) rowToModel(modelType, row)
template findRecordsWhere*( template findRecordsWhere*[D: DbConnType](
db: DbConn, db: D,
modelType: type, modelType: type,
whereClause: string, whereClause: string,
values: varargs[string, dbFormat], values: varargs[string, dbFormat],
@ -415,7 +438,7 @@ template findRecordsWhere*(
if page.isSome: if page.isSome:
let p = page.get let p = page.get
if p.orderBy.isSome: if p.orderBy.isSome:
fetchStmt &= " ORDER BY " & p.orderBy.get fetchStmt &= " ORDER BY " & identNameToDb(p.orderBy.get)
else: else:
fetchStmt &= " ORDER BY id" fetchStmt &= " ORDER BY id"
@ -432,8 +455,8 @@ template findRecordsWhere*(
if page.isNone: records.len if page.isNone: records.len
else: db.getRow(sql(countStmt), values)[0].parseInt) else: db.getRow(sql(countStmt), values)[0].parseInt)
template getAllRecords*( template getAllRecords*[D: DbConnType](
db: DbConn, db: D,
modelType: type, modelType: type,
page: Option[PaginationParams]): untyped = page: Option[PaginationParams]): untyped =
## Fetch all records of the given type. ## Fetch all records of the given type.
@ -446,7 +469,7 @@ template getAllRecords*(
if page.isSome: if page.isSome:
let p = page.get let p = page.get
if p.orderBy.isSome: if p.orderBy.isSome:
fetchStmt &= " ORDER BY " & p.orderBy.get fetchStmt &= " ORDER BY " & identNameToDb(p.orderBy.get)
else: else:
fetchStmt &= " ORDER BY id" fetchStmt &= " ORDER BY id"
@ -464,8 +487,8 @@ template getAllRecords*(
else: db.getRow(sql(countStmt))[0].parseInt) else: db.getRow(sql(countStmt))[0].parseInt)
template findRecordsBy*( template findRecordsBy*[D: DbConnType](
db: DbConn, db: D,
modelType: type, modelType: type,
lookups: seq[tuple[field: string, value: string]], lookups: seq[tuple[field: string, value: string]],
page: Option[PaginationParams]): untyped = page: Option[PaginationParams]): untyped =
@ -485,7 +508,7 @@ template findRecordsBy*(
if page.isSome: if page.isSome:
let p = page.get let p = page.get
if p.orderBy.isSome: if p.orderBy.isSome:
fetchStmt &= " ORDER BY " & p.orderBy.get fetchStmt &= " ORDER BY " & identNameToDb(p.orderBy.get)
else: else:
fetchStmt &= " ORDER BY id" fetchStmt &= " ORDER BY id"
@ -515,6 +538,7 @@ macro generateProcsForModels*(dbType: type, modelTypes: openarray[type]): untype
## proc deleteTodoItem*(db: TodoDB, rec: TodoItem): bool; ## proc deleteTodoItem*(db: TodoDB, rec: TodoItem): bool;
## proc deleteTodoItem*(db: TodoDB, id: idType): bool; ## proc deleteTodoItem*(db: TodoDB, id: idType): bool;
## proc updateTodoItem*(db: TodoDB, rec: TodoItem): bool; ## proc updateTodoItem*(db: TodoDB, rec: TodoItem): bool;
## proc createOrUpdateTodoItem*(db: TodoDB, rec: TodoItem): bool;
## ##
## proc findTodoItemsWhere*( ## proc findTodoItemsWhere*(
## db: TodoDB, whereClause: string, values: varargs[string]): TodoItem; ## db: TodoDB, whereClause: string, values: varargs[string]): TodoItem;
@ -526,12 +550,17 @@ macro generateProcsForModels*(dbType: type, modelTypes: openarray[type]): untype
result = newStmtList() result = newStmtList()
for t in modelTypes: for t in modelTypes:
if t.getType[1].typeKind == ntyRef:
raise newException(ValueError,
"fiber_orm model object must be objects, not refs")
let modelName = $(t.getType[1]) let modelName = $(t.getType[1])
let getName = ident("get" & modelName) let getName = ident("get" & modelName)
let getAllName = ident("getAll" & pluralize(modelName)) let getAllName = ident("getAll" & pluralize(modelName))
let findWhereName = ident("find" & pluralize(modelName) & "Where") let findWhereName = ident("find" & pluralize(modelName) & "Where")
let createName = ident("create" & modelName) let createName = ident("create" & modelName)
let updateName = ident("update" & modelName) let updateName = ident("update" & modelName)
let createOrUpdateName = ident("createOrUpdate" & modelName)
let deleteName = ident("delete" & modelName) let deleteName = ident("delete" & modelName)
let idType = typeOfColumn(t, "id") let idType = typeOfColumn(t, "id")
result.add quote do: result.add quote do:
@ -555,6 +584,9 @@ macro generateProcsForModels*(dbType: type, modelTypes: openarray[type]): untype
proc `updateName`*(db: `dbType`, rec: `t`): bool = proc `updateName`*(db: `dbType`, rec: `t`): bool =
db.withConn: result = updateRecord(conn, rec) db.withConn: result = updateRecord(conn, rec)
proc `createOrUpdateName`*(db: `dbType`, rec: `t`): `t` =
db.inTransaction: result = createOrUpdateRecord(conn, rec)
proc `deleteName`*(db: `dbType`, rec: `t`): bool = proc `deleteName`*(db: `dbType`, rec: `t`): bool =
db.withConn: result = deleteRecord(conn, rec) db.withConn: result = deleteRecord(conn, rec)
@ -644,11 +676,12 @@ macro generateProcsForFieldLookups*(dbType: type, modelsAndFields: openarray[tup
result.add procDefAST result.add procDefAST
proc initPool*( proc initPool*[D: DbConnType](
connect: proc(): DbConn, connect: proc(): D,
poolSize = 10, poolSize = 10,
hardCap = false, hardCap = false,
healthCheckQuery = "SELECT 'true' AS alive"): DbConnPool = healthCheckQuery = "SELECT 'true' AS alive"): DbConnPool[D] =
## Initialize a new DbConnPool. See the `initDb` procedure in the `Example ## Initialize a new DbConnPool. See the `initDb` procedure in the `Example
## Fiber ORM Usage`_ for an example ## Fiber ORM Usage`_ for an example
## ##
@ -666,13 +699,13 @@ proc initPool*(
## ##
## .. _Example Fiber ORM Usage: #basic-usage-example-fiber-orm-usage ## .. _Example Fiber ORM Usage: #basic-usage-example-fiber-orm-usage
initDbConnPool(DbConnPoolConfig( initDbConnPool(DbConnPoolConfig[D](
connect: connect, connect: connect,
poolSize: poolSize, poolSize: poolSize,
hardCap: hardCap, hardCap: hardCap,
healthCheckQuery: healthCheckQuery)) healthCheckQuery: healthCheckQuery))
template inTransaction*(db: DbConnPool, body: untyped) = template inTransaction*[D: DbConnType](db: DbConnPool[D], body: untyped) =
pool.withConn(db): pool.withConn(db):
conn.exec(sql"BEGIN TRANSACTION") conn.exec(sql"BEGIN TRANSACTION")
try: try:

View File

@ -0,0 +1,3 @@
import std/[db_postgres, db_sqlite]
type DbConnType* = db_postgres.DbConn or db_sqlite.DbConn

View File

@ -4,65 +4,70 @@
## Simple database connection pooling implementation compatible with Fiber ORM. ## Simple database connection pooling implementation compatible with Fiber ORM.
import std/db_postgres, std/sequtils, std/strutils, std/sugar import std/[db_common, logging, sequtils, strutils, sugar]
from std/db_sqlite import getRow, close
from std/db_postgres import getRow, close
import namespaced_logging import namespaced_logging
import ./db_common as fiber_db_common
type type
DbConnPoolConfig* = object DbConnPoolConfig*[D: DbConnType] = object
connect*: () -> DbConn ## Factory procedure to create a new DBConn connect*: () -> D ## Factory procedure to create a new DBConn
poolSize*: int ## The pool capacity. poolSize*: int ## The pool capacity.
hardCap*: bool ## Is the pool capacity a hard cap?
## hardCap*: bool ## Is the pool capacity a hard cap?
## When `false`, the pool can grow beyond the configured ##
## capacity, but will release connections down to the its ## When `false`, the pool can grow beyond the
## capacity (no less than `poolSize`). ## configured capacity, but will release connections
## ## down to the its capacity (no less than `poolSize`).
## When `true` the pool will not create more than its ##
## configured capacity. It a connection is requested, none ## When `true` the pool will not create more than its
## are free, and the pool is at capacity, this will result ## configured capacity. It a connection is requested,
## in an Error being raised. ## none are free, and the pool is at capacity, this
## will result in an Error being raised.
healthCheckQuery*: string ## Should be a simple and fast SQL query that the healthCheckQuery*: string ## Should be a simple and fast SQL query that the
## pool can use to test the liveliness of pooled ## pool can use to test the liveliness of pooled
## connections. ## connections.
PooledDbConn = ref object PooledDbConn[D: DbConnType] = ref object
conn: DbConn conn: D
id: int id: int
free: bool free: bool
DbConnPool* = ref object DbConnPool*[D: DbConnType] = ref object
## Database connection pool ## Database connection pool
conns: seq[PooledDbConn] conns: seq[PooledDbConn[D]]
cfg: DbConnPoolConfig cfg: DbConnPoolConfig[D]
lastId: int lastId: int
var logNs {.threadvar.}: LoggingNamespace var logNs {.threadvar.}: LoggingNamespace
template log(): untyped = template log(): untyped =
if logNs.isNil: logNs = initLoggingNamespace(name = "fiber_orm/pool", level = lvlNotice) if logNs.isNil: logNs = getLoggerForNamespace(namespace = "fiber_orm/pool", level = lvlNotice)
logNs logNs
proc initDbConnPool*(cfg: DbConnPoolConfig): DbConnPool = proc initDbConnPool*[D: DbConnType](cfg: DbConnPoolConfig[D]): DbConnPool[D] =
log().debug("Initializing new pool (size: " & $cfg.poolSize) log().debug("Initializing new pool (size: " & $cfg.poolSize)
result = DbConnPool( result = DbConnPool[D](
conns: @[], conns: @[],
cfg: cfg) cfg: cfg)
proc newConn(pool: DbConnPool): PooledDbConn = proc newConn[D: DbConnType](pool: DbConnPool[D]): PooledDbConn[D] =
log().debug("Creating a new connection to add to the pool.") log().debug("Creating a new connection to add to the pool.")
pool.lastId += 1 pool.lastId += 1
let conn = pool.cfg.connect() let conn = pool.cfg.connect()
result = PooledDbConn( result = PooledDbConn[D](
conn: conn, conn: conn,
id: pool.lastId, id: pool.lastId,
free: true) free: true)
pool.conns.add(result) pool.conns.add(result)
proc maintain(pool: DbConnPool): void = proc maintain[D: DbConnType](pool: DbConnPool[D]): void =
log().debug("Maintaining pool. $# connections." % [$pool.conns.len]) log().debug("Maintaining pool. $# connections." % [$pool.conns.len])
pool.conns.keepIf(proc (pc: PooledDbConn): bool = pool.conns.keepIf(proc (pc: PooledDbConn[D]): bool =
if not pc.free: return true if not pc.free: return true
try: try:
@ -91,7 +96,7 @@ proc maintain(pool: DbConnPool): void =
"Trimming pool size. Culled $# free connections. $# connections remaining." % "Trimming pool size. Culled $# free connections. $# connections remaining." %
[$toCull.len, $pool.conns.len]) [$toCull.len, $pool.conns.len])
proc take*(pool: DbConnPool): tuple[id: int, conn: DbConn] = proc take*[D: DbConnType](pool: DbConnPool[D]): tuple[id: int, conn: D] =
## Request a connection from the pool. Returns a DbConn if the pool has free ## Request a connection from the pool. Returns a DbConn if the pool has free
## connections, or if it has the capacity to create a new connection. If the ## connections, or if it has the capacity to create a new connection. If the
## pool is configured with a hard capacity limit and is out of free ## pool is configured with a hard capacity limit and is out of free
@ -113,13 +118,13 @@ proc take*(pool: DbConnPool): tuple[id: int, conn: DbConn] =
log().debug("Reserve connection $#" % [$reserved.id]) log().debug("Reserve connection $#" % [$reserved.id])
return (id: reserved.id, conn: reserved.conn) return (id: reserved.id, conn: reserved.conn)
proc release*(pool: DbConnPool, connId: int): void = proc release*[D: DbConnType](pool: DbConnPool[D], connId: int): void =
## Release a connection back to the pool. ## Release a connection back to the pool.
log().debug("Reclaiming released connaction $#" % [$connId]) log().debug("Reclaiming released connaction $#" % [$connId])
let foundConn = pool.conns.filterIt(it.id == connId) let foundConn = pool.conns.filterIt(it.id == connId)
if foundConn.len > 0: foundConn[0].free = true if foundConn.len > 0: foundConn[0].free = true
template withConn*(pool: DbConnPool, stmt: untyped): untyped = template withConn*[D: DbConnType](pool: DbConnPool[D], stmt: untyped): untyped =
## Convenience template to provide a connection from the pool for use in a ## Convenience template to provide a connection from the pool for use in a
## statement block, automatically releasing that connnection when done. ## statement block, automatically releasing that connnection when done.
## ##

View File

@ -3,10 +3,10 @@
# Copyright 2019 Jonathan Bernard <jonathan@jdbernard.com> # Copyright 2019 Jonathan Bernard <jonathan@jdbernard.com>
## Utility methods used internally by Fiber ORM. ## Utility methods used internally by Fiber ORM.
import json, macros, options, sequtils, strutils, times, unicode, import std/[json, macros, options, sequtils, strutils, times, unicode]
uuids import uuids
import nre except toSeq import std/nre except toSeq
type type
MutateClauses* = object MutateClauses* = object
@ -102,7 +102,7 @@ proc dbFormat*[T](list: seq[T]): string =
proc dbFormat*[T](item: T): string = proc dbFormat*[T](item: T): string =
## For all other types, fall back on a defined `$` function to create a ## For all other types, fall back on a defined `$` function to create a
## string version of the value we can include in an SQL query> ## string version of the value we can include in an SQL query.
return $item return $item
type DbArrayParseState = enum type DbArrayParseState = enum
@ -207,21 +207,14 @@ proc parseDbArray*(val: string): seq[string] =
if not (parseState == inQuote) and curStr.len > 0: if not (parseState == inQuote) and curStr.len > 0:
result.add(curStr) result.add(curStr)
proc createParseStmt*(t, value: NimNode): NimNode = func createParseStmt*(t, value: NimNode): NimNode =
## Utility method to create the Nim cod required to parse a value coming from ## Utility method to create the Nim cod required to parse a value coming from
## the a database query. This is used by functions like `rowToModel` to parse ## the a database query. This is used by functions like `rowToModel` to parse
## the dataabase columns into the Nim object fields. ## the dataabase columns into the Nim object fields.
#echo "Creating parse statment for ", t.treeRepr
if t.typeKind == ntyObject: if t.typeKind == ntyObject:
if t.getType == UUID.getType: if t.getTypeInst == Option.getType:
result = quote do: parseUUID(`value`)
elif t.getType == DateTime.getType:
result = quote do: parsePGDatetime(`value`)
elif t.getTypeInst == Option.getType:
var innerType = t.getTypeImpl[2][0] # start at the first RecList var innerType = t.getTypeImpl[2][0] # start at the first RecList
# If the value is a non-pointer type, there is another inner RecList # If the value is a non-pointer type, there is another inner RecList
if innerType.kind == nnkRecList: innerType = innerType[0] if innerType.kind == nnkRecList: innerType = innerType[0]
@ -232,8 +225,28 @@ proc createParseStmt*(t, value: NimNode): NimNode =
if `value`.len == 0: none[`innerType`]() if `value`.len == 0: none[`innerType`]()
else: some(`parseStmt`) else: some(`parseStmt`)
elif t.getType == UUID.getType:
result = quote do: parseUUID(`value`)
elif t.getType == DateTime.getType:
result = quote do: parsePGDatetime(`value`)
else: error "Unknown value object type: " & $t.getTypeInst else: error "Unknown value object type: " & $t.getTypeInst
elif t.typeKind == ntyGenericInst:
if t.kind == nnkBracketExpr and
t.len > 0 and
t[0] == Option.getType:
var innerType = t.getTypeInst[1]
let parseStmt = createParseStmt(innerType, value)
result = quote do:
if `value`.len == 0: none[`innerType`]()
else: some(`parseStmt`)
else: error "Unknown generic instance type: " & $t.getTypeInst
elif t.typeKind == ntyRef: elif t.typeKind == ntyRef:
if $t.getTypeInst == "JsonNode": if $t.getTypeInst == "JsonNode":
@ -268,28 +281,72 @@ proc createParseStmt*(t, value: NimNode): NimNode =
else: else:
error "Unknown value type: " & $t.typeKind error "Unknown value type: " & $t.typeKind
func fields(t: NimNode): seq[tuple[fieldIdent: NimNode, fieldType: NimNode]] =
#[
debugEcho "T: " & t.treeRepr
debugEcho "T.kind: " & $t.kind
debugEcho "T.typeKind: " & $t.typeKind
debugEcho "T.GET_TYPE[1]: " & t.getType[1].treeRepr
debugEcho "T.GET_TYPE[1].kind: " & $t.getType[1].kind
debugEcho "T.GET_TYPE[1].typeKind: " & $t.getType[1].typeKind
debugEcho "T.GET_TYPE: " & t.getType.treeRepr
debugEcho "T.GET_TYPE[1].GET_TYPE: " & t.getType[1].getType.treeRepr
]#
# Get the object type AST, with base object (if present) and record list.
var objDefAst: NimNode
if t.typeKind == ntyObject: objDefAst = t.getType
elif t.typeKind == ntyTypeDesc:
# In this case we have a type AST that is like:
# BracketExpr
# Sym "typeDesc"
# Sym "ModelType"
objDefAst = t.
getType[1]. # get the Sym "ModelType"
getType # get the object definition type
if objDefAst.kind != nnkObjectTy:
error ("unable to enumerate the fields for model type '$#', " &
"tried to resolve the type of the provided symbol to an object " &
"definition (nnkObjectTy) but got a '$#'.\pAST:\p$#") % [
$t, $objDefAst.kind, objDefAst.treeRepr ]
else:
error ("unable to enumerate the fields for model type '$#', " &
"expected a symbol with type ntyTypeDesc but got a '$#'.\pAST:\p$#") % [
$t, $t.typeKind, t.treeRepr ]
# At this point objDefAst should look something like:
# ObjectTy
# Empty
# Sym "BaseObject"" | Empty
# RecList
# Sym "field1"
# Sym "field2"
# ...
if objDefAst[1].kind == nnkSym:
# We have a base class symbol, let's recurse and try and resolve the fields
# for the base class
for fieldDef in objDefAst[1].fields: result.add(fieldDef)
for fieldDef in objDefAst[2].children:
# objDefAst[2] is a RecList of
# ignore AST nodes that are not field definitions
if fieldDef.kind == nnkIdentDefs: result.add((fieldDef[0], fieldDef[1]))
elif fieldDef.kind == nnkSym: result.add((fieldDef, fieldDef.getTypeInst))
else: error "unknown object field definition AST: $#" % $fieldDef.kind
template walkFieldDefs*(t: NimNode, body: untyped) = template walkFieldDefs*(t: NimNode, body: untyped) =
## Iterate over every field of the given Nim object, yielding and defining ## Iterate over every field of the given Nim object, yielding and defining
## `fieldIdent` and `fieldType`, the name of the field as a Nim Ident node ## `fieldIdent` and `fieldType`, the name of the field as a Nim Ident node
## and the type of the field as a Nim Type node respectively. ## and the type of the field as a Nim Type node respectively.
let tTypeImpl = t.getTypeImpl for (fieldIdent {.inject.}, fieldType {.inject.}) in t.fields: body
var nodeToItr: NimNode #[ TODO: replace walkFieldDefs with things like this:
if tTypeImpl.typeKind == ntyObject: nodeToItr = tTypeImpl[2] func columnNamesForModel*(modelType: typedesc): seq[string] =
elif tTypeImpl.typeKind == ntyTypeDesc: nodeToItr = tTypeImpl.getType[1].getType[2] modelType.fields.mapIt(identNameToDb($it[0]))
else: error $t & " is not an object or type desc (it's a " & $tTypeImpl.typeKind & ")." ]#
for fieldDef {.inject.} in nodeToItr.children:
# ignore AST nodes that are not field definitions
if fieldDef.kind == nnkIdentDefs:
let fieldIdent {.inject.} = fieldDef[0]
let fieldType {.inject.} = fieldDef[1]
body
elif fieldDef.kind == nnkSym:
let fieldIdent {.inject.} = fieldDef
let fieldType {.inject.} = fieldDef.getType
body
macro columnNamesForModel*(modelType: typed): seq[string] = macro columnNamesForModel*(modelType: typed): seq[string] =
## Return the column names corresponding to the the fields of the given ## Return the column names corresponding to the the fields of the given
@ -317,6 +374,7 @@ macro rowToModel*(modelType: typed, row: seq[string]): untyped =
createParseStmt(fieldType, itemLookup))) createParseStmt(fieldType, itemLookup)))
idx += 1 idx += 1
#[
macro listFields*(t: typed): untyped = macro listFields*(t: typed): untyped =
var fields: seq[tuple[n: string, t: string]] = @[] var fields: seq[tuple[n: string, t: string]] = @[]
t.walkFieldDefs: t.walkFieldDefs:
@ -324,6 +382,7 @@ macro listFields*(t: typed): untyped =
else: fields.add((n: $fieldIdent, t: $fieldType)) else: fields.add((n: $fieldIdent, t: $fieldType))
result = newLit(fields) result = newLit(fields)
]#
proc typeOfColumn*(modelType: NimNode, colName: string): NimNode = proc typeOfColumn*(modelType: NimNode, colName: string): NimNode =
## Given a model type and a column name, return the Nim type for that column. ## Given a model type and a column name, return the Nim type for that column.
@ -370,8 +429,8 @@ macro populateMutateClauses*(t: typed, newRecord: bool, mc: var MutateClauses):
# if we're looking at an optional field, add logic to check for presence # if we're looking at an optional field, add logic to check for presence
elif fieldType.kind == nnkBracketExpr and elif fieldType.kind == nnkBracketExpr and
fieldType.len > 0 and fieldType.len > 0 and
fieldType[0] == Option.getType: fieldType[0] == Option.getType:
result.add quote do: result.add quote do:
`mc`.columns.add(identNameToDb(`fieldName`)) `mc`.columns.add(identNameToDb(`fieldName`))