nim-allographer 项目教程

nim-allographer 项目教程

nim-allographer A query_builder/ORM library inspired by Laravel/PHP and Orator/Python for Nim 项目地址: https://gitcode.com/gh_mirrors/ni/nim-allographer

1. 项目的目录结构及介绍

nim-allographer 项目的目录结构如下：

nim-allographer/
├── docs/
├── example/
├── src/
│   └── allographer/
├── tests/
├── .gitignore
├── LICENSE
├── README.md
├── allographer.nimble
├── compose-test.yaml
├── compose.yaml
├── config.nims
└── permission.sh

目录介绍

• docs/: 存放项目的文档文件。
• example/: 存放项目的示例代码。
• src/allographer/: 存放项目的源代码，核心功能实现。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• allographer.nimble: Nimble 配置文件，用于项目的依赖管理。
• compose-test.yaml: Docker Compose 测试配置文件。
• compose.yaml: Docker Compose 配置文件。
• config.nims: 项目的配置文件。
• permission.sh: 权限相关的脚本文件。

2. 项目的启动文件介绍

nim-allographer 项目的启动文件主要位于 src/allographer/ 目录下。核心文件包括：

• connection.nim: 数据库连接相关的代码。
• query_builder.nim: 查询构建器的实现。
• schema_builder.nim: 数据库模式构建器的实现。

启动流程

1. 导入模块: 在启动文件中，首先导入必要的模块，如 asyncdispatch 和 allographer/connection。
2. 创建数据库连接: 使用 dbOpen 函数创建数据库连接，支持多种数据库类型（如 PostgreSQL、SQLite、MySQL 等）。
3. 执行查询: 使用查询构建器执行数据库查询操作。

示例代码：

import asyncdispatch, json
import allographer/connection
import allographer/query_builder

let maxConnections = 95
let timeout = 30
let rdb = dbOpen(PostgreSql, "database", "user", "password", "localhost", 5432, maxConnections, timeout)

proc main() {.async.} =
  let result = await rdb.table("users").select("id", "email", "name").limit(5).offset(10).get()
  echo result

waitFor main()

3. 项目的配置文件介绍

nim-allographer 项目的配置文件主要包括 config.nims 和 allographer.nimble。

config.nims

config.nims 文件用于配置项目的编译选项和环境变量。示例内容如下：

import os

putEnv("DB_SQLITE", $true)
putEnv("DB_POSTGRES", $true)

allographer.nimble

allographer.nimble 文件是 Nimble 配置文件，用于管理项目的依赖和编译选项。示例内容如下：

# Package

version       = "0.1.0"
author        = "itsumura-h"
description   = "A query_builder/ORM library inspired by Laravel/PHP and Orator/Python for Nim"
license       = "MIT"

# Dependencies

requires "nim >= 1.6.14"

通过这些配置文件，可以灵活地配置项目的编译选项和环境变量，确保项目在不同环境下能够正常运行。

nim-allographer A query_builder/ORM library inspired by Laravel/PHP and Orator/Python for Nim 项目地址: https://gitcode.com/gh_mirrors/ni/nim-allographer