Skip to content

Commit

Permalink
Polish
Browse files Browse the repository at this point in the history
  • Loading branch information
nakamura-to committed Mar 11, 2022
1 parent ee4912e commit 5aa4b31
Show file tree
Hide file tree
Showing 15 changed files with 24 additions and 35 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/delete.md
@@ -1,5 +1,5 @@
---
title: "DELETE Query"
title: "DELETE Queries"
linkTitle: "DELETE"
weight: 40
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/insert.md
@@ -1,5 +1,5 @@
---
title: "INSERT Query"
title: "INSERT Queries"
linkTitle: "INSERT"
weight: 20
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/schema.md
@@ -1,5 +1,5 @@
---
title: "SCHEMA Query"
title: "SCHEMA Queries"
linkTitle: "SCHEMA"
weight: 60
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/script.md
@@ -1,5 +1,5 @@
---
title: "SCRIPT Query"
title: "SCRIPT Queries"
linkTitle: "SCRIPT"
weight: 60
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/select.md
@@ -1,5 +1,5 @@
---
title: "SELECT Query"
title: "SELECT Queries"
linkTitle: "SELECT"
weight: 10
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/template.md
@@ -1,5 +1,5 @@
---
title: "TEMPLATE Query"
title: "TEMPLATE Queries"
linkTitle: "TEMPLATE"
weight: 50
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/update.md
@@ -1,5 +1,5 @@
---
title: "UPDATE Query"
title: "UPDATE Queries"
linkTitle: "UPDATE"
weight: 30
description: >
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Reference/database.md
Expand Up @@ -11,7 +11,7 @@ Here, these are collectively referred to as Database instances.

The Database instances are responsible for transaction control and query execution.

## Creation of Database instance {#instantiation}
## Instantiation {#instantiation}

The method of creating a Database instance differs when using JDBC or R2DBC.

Expand Down Expand Up @@ -81,7 +81,7 @@ val db: R2dbcDatabase = R2dbcDatabase(

See also [Dialect]({{< relref "Dialect" >}}).

## Use of Database instances {#usage}
## Usage {#usage}

### Transaction Control {#transaction-control}

Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/Reference/entity-class.md
Expand Up @@ -14,7 +14,7 @@ Mapping definitions using annotations are necessary to map entity classes to tab

The metamodels are used in the construction and execution of queries.

## Entity class definition {#entity-class-definition}
## Entity class definitions {#entity-class-definition}

Entity classes must meet the following requirements:

Expand Down Expand Up @@ -47,10 +47,10 @@ data class Address(
)
```

The mapping between property types (Kotlin types) and
column types (database types) is defined by [Dialects]({{< relref "dialect.md" >}}).
The type mappings between properties and columns
are defined by [Dialects]({{< relref "dialect.md" >}}).

## Mapping definition {#mapping-definition}
## Mapping definitions {#mapping-definition}

There are two ways to create a mapping definition:

Expand Down Expand Up @@ -122,7 +122,7 @@ even though it does not appear in the separation mapping.
There are no restrictions on the types of properties in the separation mapping.
We use `Nothing` in the above example.

## Metamodel {#metamodel}
## Metamodels {#metamodel}

From a mapping definition, a metamodel is generated
in the form of an implementation of the `org.komapper.core.dsl.metamodel.EntityMetamodel` interface.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Reference/starter.md
Expand Up @@ -9,7 +9,7 @@ description: >
The Starter module makes it easy to start a project using Komapper.
There are several types of starter modules.

## Simple starter {#simple-starter}
## Simple starters {#simple-starter}

### komapper-starter-jdbc

Expand All @@ -35,7 +35,7 @@ dependencies {
}
```

## Spring Boot starter {#spring-boot-starter}
## Spring Boot starters {#spring-boot-starter}

### komapper-spring-boot-starter-jdbc

Expand Down
15 changes: 2 additions & 13 deletions content/ja/docs/Reference/Query/introduction.md
Expand Up @@ -7,7 +7,8 @@ description: >
## 概要 {#overview}

Komapperではクエリの構築と実行は分離されています。
クエリの構築は各種のDSLが担い、実行はJDBCやR2DBCを表す [データベース]({{< relref "../database.md" >}}) インスタンスが担います。
クエリの構築は [Query DSL]({{< relref "QueryDSL" >}}) が担い、
実行はJDBCやR2DBCを表す [データベース]({{< relref "../database.md" >}}) インスタンスが担います。

```kotlin
// construct a query
Expand All @@ -16,18 +17,6 @@ val query: Query<List<Address>> = QueryDsl.from(a)
val result: List<Address> = db.runQuery { query }
```

クエリの構築を担うDSLについては下記のページを参照ください。

- [Query DSL]({{< relref "QueryDsl" >}})

複数のクエリを1つのクエリに合成する方法については下記のページを参照ください。

- [クエリの合成]({{< relref "composition.md" >}})

クエリのデバッグの仕方については下記のページを参照ください。

- [クエリのデバッグ]({{< relref "debugging.md" >}})

## 前提条件 {#prerequisites}

[クエリ]({{< relref "../Query" >}}) の下位ページでは、下記のエンティティ定義、マッピング定義、変数が存在することを前提に説明をします。
Expand Down
6 changes: 3 additions & 3 deletions content/ja/docs/Reference/database.md
Expand Up @@ -11,7 +11,7 @@ Komapperでデータベースにアクセスするためには`JdbcDatabase`も

Databaseインスタンスはトランザクションの制御やクエリの実行を担当します。

## Databaseインスタンスの生成 {#instantiation}
## インスタンスの生成 {#instantiation}

Databaseインスタンスの生成方法はJDBCを使う場合とR2DBCを使う場合で異なります。

Expand Down Expand Up @@ -80,7 +80,7 @@ val db: R2dbcDatabase = R2dbcDatabase(

[ダイアレクト]({{< relref "dialect.md" >}})も参照ください。

## Databaseインスタンスの利用 {#usage}
## インスタンスの利用 {#usage}

### トランザクションの制御 {#transaction-control}

Expand Down Expand Up @@ -144,4 +144,4 @@ db.config.session.getConnection().use { con ->
```kotlin
val db: R2dbcDatabase = ...
val connection: Connection = db.config.session.getConnection()
```
```
2 changes: 1 addition & 1 deletion content/ja/docs/Reference/entity-class.md
Expand Up @@ -46,7 +46,7 @@ data class Address(
)
```

プロパティの型(Kotlinの型)とカラムの型(データベースの型)の対応関係は [ダイアレクト]({{< relref "Dialect" >}}) で定義されます。
プロパティとカラムの間における型の対応関係は [ダイアレクト]({{< relref "Dialect" >}}) で定義されます。

## マッピング定義 {#mapping-definition}

Expand Down
2 changes: 1 addition & 1 deletion content/ja/docs/Reference/logging.md
Expand Up @@ -53,7 +53,7 @@ Commit: JdbcTransaction(id=a108b824-3353-475c-a29b-cb1575951803, name=null)
このカテゴリは他のどのカテゴリにも属さないログを表します。
任意のログレベルで出力されます。

## LoggerFacadeの利用例 {#loggerfacade}
## LoggerFacadeの利用 {#loggerfacade}

LoggerFacadeを使えば、ログメッセージやログレベルの変更ができます。

Expand Down
2 changes: 1 addition & 1 deletion content/ja/docs/Reference/transaction.md
Expand Up @@ -144,7 +144,7 @@ db.withTransaction { tx ->

## トランザクショナルなFlow {#transactional-flow}

`R2dbcDatabase`のみがトランザクションを表す`Flow`を構築するための`flowTransaction`関数を提供します。
`R2dbcDatabase`はトランザクションを表す`Flow`を構築するための`flowTransaction`関数を提供します。

```kotlin
val db = R2dbcDatabase("r2dbc:h2:mem:///example;DB_CLOSE_DELAY=-1")
Expand Down

0 comments on commit 5aa4b31

Please sign in to comment.