Rails Models Reverse Engineering 技术文档
2024-12-18 15:31:37作者:魏侃纯Zoe
1. 安装指南
Rmre
是一个用于为遗留数据库创建 Ruby on Rails ActiveRecord 模型的实用工具。你可以通过以下命令安装 Rmre
:
gem install rmre
2. 项目的使用说明
Rmre
的使用非常简单,只需在命令行中运行以下命令:
rmre -a mysql2 -d my_database -u my_username -p my_password -o /path/where/models/will/be/created
该命令将根据指定的数据库连接信息,生成相应的 ActiveRecord 模型文件,并将其保存到指定的输出目录中。
2.1 获取帮助
如果你需要查看所有可用的命令行选项,可以运行以下命令:
rmre --help
或
rmre -h
2.2 MS SQL 选项
对于 MS SQL 数据库,你可以使用以下选项来设置 ODBC 特定的参数:
-m
或--mode
:必须设置为ODBC
。-n
或--dsn
:数据源名称。
2.3 通用选项
-
输出目录可以通过以下选项设置:
-o /path/to/target/directory
或
--out /path/to/target/directory
如果未指定输出目录,
Rmre
将在启动目录中创建模型文件。 -
你可以通过以下选项过滤需要生成模型的表:
-i ec_,vi_
或
--include ic_,vi_
这将仅生成以
ec_
或vi_
开头的表的模型。
3. 项目API使用文档
3.1 配置文件生成
Rmre
支持通过配置文件来设置数据库连接和输出路径,而不是通过命令行选项。你可以通过以下命令生成示例配置文件:
rmre -o /tmp/test -f
这将生成两个文件:/tmp/test/rmre_db.rb
和 /tmp/test/rmre_db.yml
。
3.2 配置文件示例
生成的配置文件 rmre_db.yml
示例如下:
---
:db:
:username: ''
:password: ''
:port:
:timeout: 5000
:adapter: adapter_name
:database: db_name
:out_path: /tmp/test
你可以根据需要修改配置文件中的值,然后通过以下命令启动 Rmre
:
rmre -f /tmp/test/rmre_db.yml
3.3 自定义词形变化
如果表名不符合 Rails 命名约定,Rmre
允许在配置文件中定义额外的词形变化规则,以正确转换表名。例如:
:inflections:
- :plural:
- (.*)_des$
- \1_des
:singular:
- (.*)_des$
- \1_des
- :plural:
- (.*)_fis$
- rmre_\1_d
:singular:
- (.*)_fis$
- rmre_\1_d
4. 项目安装方式
Rmre
可以通过 RubyGems 安装,安装命令如下:
gem install rmre
安装完成后,你可以通过命令行使用 Rmre
来生成 ActiveRecord 模型。
热门项目推荐
相关项目推荐
鸿蒙开发工具大赶集
本仓将收集和展示鸿蒙开发工具,欢迎大家踊跃投稿。通过pr附上您的工具介绍和使用指南,并加上工具对应的链接,通过的工具将会成功上架到我们社区。017inference
通过更改一行代码,您可以在应用程序中用另一个大型语言模型(LLM)替换OpenAI GPT。Xinference赋予您使用任何所需LLM的自由。借助Xinference,您能够在云端、本地、甚至笔记本电脑上运行任何开源语言模型、语音识别模型和多模态模型的推理。Python00每日精选项目
🔥🔥 每日精选已经升级为:【行业动态】,快去首页看看吧,后续都在【首页 - 行业动态】内更新,多条更新哦~🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~032BootstrapAdmin
基于 RBAC 的 Net8 后台管理框架,权限管理,前后台分离,支持多站点单点登录,兼容所有主流浏览器,内置微信、支付宝、QQ等多种登录方式,内置多种样式,可切换至 Blazor 多 Tabs 模式,权限控制细化到网页内任意元素(按钮、表格、文本框等等)C#00phalapi
PhalApi开源接口框架,简称π框架,一个轻量级PHP开源接口框架,专注于接口服务开发。接口,从简单开始!Objective-C00Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie062毕方Talon工具
本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python040PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython06mybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区018
热门内容推荐
最新内容推荐
项目优选
收起

Python - 100天从新手到大师
Python
657
122

React Native鸿蒙化仓库
C++
11
22

方舟分析器:面向ArkTS语言的静态程序分析框架
TypeScript
7
11

open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
90
65

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
209
61

🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
46
31

本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
289
82

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
901
0

🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
49