Skip to content

Commit

Permalink
Merge pull request #14 from koyopro/feature/readme
Browse files Browse the repository at this point in the history
update README
  • Loading branch information
koyopro authored Jun 17, 2024
2 parents b137126 + 95804f7 commit 3550618
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
21 changes: 21 additions & 0 deletions packages/accel-record/README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@ Active Recordパターンを採用しており、インターフェースはRuby
- 同期的なAPI
- MySQL, SQLiteのサポート

## 目次

- [利用例](#利用例)
- [Installation](#installation)
- [Quick Start](#quick-Start)
- [Examples](#examples)
- [モデルの型](#モデルの型)
- [Prismaスキーマとフィールドの型](#prismaスキーマとフィールドの型)
- [Jsonフィールドの型](#jsonフィールドの型)
- [関連付け](#関連付け)
- [クエリインターフェース](#クエリインターフェース)
- [テスト](#テスト)
- [バリデーション](#バリデーション)
- [Serialization](#serialization)
- [Bulk Insert](#bulk-Insert)
- [トランザクション](#トランザクション)
- [国際化(I18n)](#国際化i18n)
- [Nullableな値の扱いについて](#nullableな値の扱いについて)
- [今後予定されている機能追加](#今後予定されている機能追加)

## 利用例

例えば以下のようにUserモデルを定義した場合、
Expand Down Expand Up @@ -1151,5 +1171,6 @@ user.update({ age: undefined });
- [accel-record-core] PostgreSQLのサポート
- [accel-record-core] 複合IDの対応
- [accel-record-core] クエリインターフェースの拡充
- [accel-record-core] コールバック
関連: [Accel Record Roadmap](https://github.com/koyopro/accella/issues/1)
21 changes: 21 additions & 0 deletions packages/accel-record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@ We currently support MySQL and SQLite, and plan to support PostgreSQL in the fut
- Synchronous API
- Support for MySQL and SQLite

## Table of Contents

- [Usage](#usage)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Examples](#examples)
- [Model Types](#model-types)
- [Prisma Schema and Field Types](#prisma-schema-and-field-types)
- [Type of Json Field](#type-of-json-field)
- [Associations](#associations)
- [Query Interface](#query-interface)
- [Testing](#testing)
- [Validation](#validation)
- [Serialization](#serialization)
- [Bulk Insert](#bulk-insert)
- [Transactions](#transactions)
- [Internationalization (I18n)](#internationalization-i18n)
- [Nullable Values Handling](#nullable-values-handling)
- [Future Planned Features](#future-planned-features)

## Usage

For example, if you define a User model like this:
Expand Down Expand Up @@ -1150,5 +1170,6 @@ user.update({ age: undefined });
- [accel-record-core] PostgreSQL Support
- [accel-record-core] Support for Composite IDs
- [accel-record-core] Expansion of Query Interface
- [accel-record-core] Callbacks
Related: [Accel Record Roadmap](https://github.com/koyopro/accella/issues/1)

0 comments on commit 3550618

Please sign in to comment.