README

用于 TinyQueries™ 编译器的 PHP 编写的命令行界面

安装

确保您有 TinyQueries™ 编译器的 API 密钥。您可以在以下位置获取：[https://tinyqueries.com/signup](https://tinyqueries.com/signup)。您可以选择将 TINYQUERIES_API_KEY 添加到您的环境变量中，或者如果您有，则添加到项目的 .env 文件中。
确保您有 PHP v7.0 或更高版本
对于 Windows，从本存储库下载文件 bin/tqc.phar 和 bin/tqc.bat，并将它们放在您的 PATH 路径中的一个文件夹中

对于 Mac/Linux，运行以下命令

wget https://github.com/querytechnology/tqc-php/raw/master/bin/tqc.phar
sudo mv tqc.phar /usr/local/bin/tqc
sudo chmod +x /usr/local/bin/tqc

为您的项目设置 TinyQueries™

假设您有一个项目文件夹。它可以是一个空文件夹，也可以包含其他代码的文件夹。

在项目文件夹内创建一个文件夹（例如 tinyqueries），在其中放置您的 TinyQueries 源查询
在项目文件夹内创建一个文件夹（例如 sql），您希望编译器将编译后的查询放在此文件夹中
在项目文件夹的根目录下创建一个配置文件 tinyqueries.json 或 tinyqueries.yaml。例如

project:
  label: your-project-label
compiler:
  dialect: mysql
  input: ./tinyqueries
  output: ./sql

有关配置文件的更详细说明，请参阅https://compile.tinyqueries.com

编译您的查询

一旦您设置了项目，只需执行以下操作

tqc

每次您想要编译源文件时，从项目文件夹中执行

将库用作 PHP 包

如果您想在 PHP 脚本内部调用 TinyQueries™ 编译器，而不是从命令行调用，可以按照以下方式操作

composer require querytechnology/tqc

示例 PHP 文件：如何编译您的查询

<?php

require_once './vendor/autoload.php';

use TinyQueries\Compiler;

$compiler = new Compiler();
$apiKey = 'your-api-key';
$config = [
  'project' => [
    'label' => 'your-project-label'
  ],
  'compiler' => [
    'dialect' => 'mysql',
    'input' => './tinyqueries',
    'output' => './sql'
  ]
];
$compiler->compile($config, $apiKey);

querytechnology / tqc

维护者

详情

README

安装

为您的项目设置 TinyQueries™

编译您的查询

将库用作 PHP 包