首页
/ GitModel 技术文档

GitModel 技术文档

2024-12-20 15:09:11作者:傅爽业Veleda

GitModel 是一个使用 Git 进行版本控制和远程同步的 Ruby 持久化框架,兼容 ActiveModel,可单独使用或作为 ActiveRecord 或 DataMapper 的替代品。本文档将指导用户如何安装、使用 GitModel,并提供 API 使用文档。

安装指南

GitModel 可作为 RubyGem 安装:

gem install gitmodel

使用说明

配置

在使用 GitModel 之前,需要设置数据库根目录:

GitModel.db_root = '/tmp/gitmodel-data'
GitModel.create_db!

定义模型

使用 include GitModel::Persistable 将 ActiveModel 功能集成到自定义模型中,并通过 attribute 方法定义属性:

class Post
  include GitModel::Persistable

  attribute :title
  attribute :body
  attribute :categories, :default => []
  attribute :allow_comments, :default => true

  blob :image
end

创建和保存对象

创建对象并设置属性,然后调用 save! 方法将其保存到数据库:

p1 = Post.new(:id => 'lessons-learned', :title => 'Lessons learned', :body => '...')
p1.image = some_binary_data
p1.save!

查询对象

使用 find 方法根据对象 ID 查询对象:

p = Post.find('lessons-learned')

使用 Git 功能

GitModel 使用 Git 仓库存储数据库,因此可以使用 Git 工具进行操作,例如:

git checkout -f

这将显示数据库的文件结构,可以查看和编辑文件,然后使用 git commit 提交更改。

API 使用文档

GitModel 类

  • db_root: 设置数据库根目录
  • create_db!: 创建数据库
  • memcache_servers: 配置 memcached 服务器
  • memcache_namespace: 配置 memcached 命名空间

Persistable 模块

  • attribute: 定义模型属性
  • blob: 定义二进制属性
  • new: 创建新对象
  • save!: 保存对象
  • find: 查询对象

性能优化

GitModel 支持使用 memcached 缓存查询结果,可以通过 memcache_servers 方法配置 memcached 服务器。

贡献

如有改进建议,请在 GitHub 提交 pull request 或 patch,并包含 RSpec 编写的测试。

总结

GitModel 是一个功能强大的持久化框架,具有版本控制、远程同步和易于使用的 API 等特点。本文档提供了安装、使用和 API 使用指南,帮助用户快速上手 GitModel。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512