corncodecreations/sql-normalizer

将 SQL 字符串适配到最佳可行标准。

v1.1.0 2024-08-02 19:06 UTC

This package is auto-updated.

Last update: 2024-09-04 15:40:12 UTC


README

一个用于标准化和改进您的 SQL 字符串的工具。

背景

SQL 文件通常在时间压力下创建,导致其结构不一致和错误。随着时间的推移,这些问题可能会变得麻烦,尤其是在数据库管理系统发生变化或作为优化代码库的一部分需要更严格的语法时。

保持一致的 SQL 结构对维护一个可靠和可维护的代码库非常重要。《SqlNormalizer》旨在通过提供一种有效适配和标准化 SQL 字符串的方法来解决这个问题。

解决方案

SqlNormalizer 通过分析您提供的 SQL 字符串,并自动调整它们以满足现代 SQL 标准。该工具纠正语法问题,应用一致的格式化,并确保您的 SQL 代码遵循最佳实践。

这在使用旧版 SQL 文件或确保新查询符合标准时尤其有用。

功能

  • 语法校正:修复常见的语法错误,以确保与现代 SQL 的兼容性。
  • 一致性格式化:对您的 SQL 文件应用统一的格式,使其更容易阅读和维护。
  • 最佳实践:实施推荐的最佳实践,以提高 SQL 代码的性能和可靠性。
  • 自定义规则:允许自定义格式化和语法规则,以适应您的特定项目需求。

安装

$ composer require corncodecreations/sql-normalizer

使用方法

SqlNormalizer 提供了静态函数,可以将 SQL 字符串转换为经过清洗和标准化的 SQL 字符串。

示例

use CornCodeCreations\SqlNormalizer\Statement\AlterTable;

$sql           = "...";
$sqlNormalized =  AlterTable::addPrimaryKey_sanitizeColumnName($sql);

贡献

SqlNormalizer 是一个处于早期阶段的开源项目。根据需要,将进行更新和改进。随着工具的发展,欢迎社区贡献。无论您是否有新功能、改进或错误修复的想法,您的帮助都将受到欢迎。

如何贡献

  • 报告问题:如果您遇到任何错误或有一些建议,可以在我们的 GitHub 仓库上打开一个问题。
  • 提交拉取请求:如果您有代码更改或新功能要贡献,请随时提交拉取请求。
  • 提供反馈:欢迎对可用性、功能或其他任何方面的工具提供反馈。

我们鼓励合作,并期待在社区的协助下构建一个有用的工具。