TextQL 开源项目使用教程

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

TextQL 是一个用于在结构化文本（如 CSV 或 TSV）上执行 SQL 查询的工具。以下是 TextQL 项目的目录结构及其介绍：

textql/
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── cmd/
│   └── textql/
│       └── main.go
├── docker/
│   └── Dockerfile
├── docs/
│   └── examples/
├── go.mod
├── go.sum
├── internal/
│   ├── executor/
│   ├── input/
│   ├── output/
│   └── schema/
├── pkg/
│   ├── cli/
│   ├── config/
│   ├── errors/
│   ├── logger/
│   └── version/
└── scripts/
    └── build.sh

• cmd/textql/main.go: 项目的启动文件。
• internal/: 包含项目的核心逻辑，如执行器、输入处理、输出处理和模式定义。
• pkg/: 包含项目的公共包，如命令行接口、配置、错误处理、日志和版本信息。
• docs/: 包含项目的文档和示例。
• scripts/: 包含构建脚本。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/textql/main.go。该文件是 TextQL 应用程序的入口点，负责初始化配置、解析命令行参数并启动应用程序。

package main

import (
    "github.com/dinedal/textql/pkg/cli"
    "github.com/dinedal/textql/pkg/config"
    "github.com/dinedal/textql/pkg/logger"
)

func main() {
    cfg := config.NewConfig()
    logger.Init(cfg.Verbose)
    cli.Run(cfg)
}

• config.NewConfig(): 初始化配置。
• logger.Init(cfg.Verbose): 初始化日志系统。
• cli.Run(cfg): 运行命令行接口。

3. 项目的配置文件介绍

TextQL 项目没有传统的配置文件，而是通过命令行参数进行配置。以下是一些常用的命令行参数：

textql -sql "SELECT * FROM table" -source data.csv

• -sql: 指定要执行的 SQL 查询。
• -source: 指定输入文件的路径。

通过这些参数，用户可以灵活地配置 TextQL 的行为。

---

以上是 TextQL 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 TextQL。