Skip to content

Commit

Permalink
Update the title and linkTitle
Browse files Browse the repository at this point in the history
  • Loading branch information
nakamura-to committed Mar 11, 2022
1 parent b7edeb7 commit cf9ed4f
Show file tree
Hide file tree
Showing 40 changed files with 53 additions and 70 deletions.
2 changes: 1 addition & 1 deletion content/en/docs/Examples/_index.md
Expand Up @@ -6,7 +6,7 @@ description: >
Here are some examples
---

## overview {#overview}
## Overview {#overview}

We provide several sample applications including JDBC access, R2DBC access,
[Spring Boot](https://spring.io/projects/spring-boot) integration,
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Reference/Query/QueryDsl/_index.md
@@ -1,6 +1,5 @@
---
title: "Query DSL"
linkTitle: "Query DSL"
weight: 30
description: >
---
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Reference/Query/QueryDsl/builder.md
@@ -1,6 +1,6 @@
---
title: "Builder"
linkTitle: "Builder"
title: "Query Builders"
linkTitle: "Builders"
weight: 300
description: >
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/delete.md
@@ -1,5 +1,5 @@
---
title: "DELETE"
title: "DELETE Query"
linkTitle: "DELETE"
weight: 40
description: >
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Reference/Query/QueryDsl/expression.md
@@ -1,6 +1,6 @@
---
title: "Expression"
linkTitle: "Expression"
title: "Query Expressions"
linkTitle: "Expressions"
weight: 200
description: >
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/QueryDsl/insert.md
@@ -1,5 +1,5 @@
---
title: "INSERT"
title: "INSERT Query"
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"
title: "SCHEMA Query"
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"
title: "SCRIPT Query"
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"
title: "SELECT Query"
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"
title: "TEMPLATE Query"
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"
title: "UPDATE Query"
linkTitle: "UPDATE"
weight: 30
description: >
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Reference/Query/_index.md
@@ -1,6 +1,5 @@
---
title: "Query"
linkTitle: "Query"
title: "Queries"
weight: 30
description: >
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/composition.md
@@ -1,5 +1,5 @@
---
title: "Composition"
title: "Query Composition"
linkTitle: "Composition"
weight: 110
description: >
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Reference/Query/debugging.md
@@ -1,5 +1,5 @@
---
title: "Debugging"
title: "Query Debugging"
linkTitle: "Debugging"
weight: 120
description: >
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/Reference/Query/introduction.md
@@ -1,5 +1,5 @@
---
title: "Introduction"
title: "Query Introduction"
linkTitle: "Introduction"
weight: 1
description: >
Expand All @@ -20,7 +20,7 @@ val result: List<Address> = db.runQuery { query }

## Prerequisites {#prerequisites}

The pages under [Query]({{< relref "../Query" >}}) assume that
The pages under [Queries]({{< relref "../Query" >}}) assume that
the following entity definitions, mapping definitions, and variables exist.

```kotlin
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Reference/_index.md
@@ -1,6 +1,5 @@
---
title: "Reference"
linkTitle: "Reference"
weight: 4
description: More about Komapper features
---
1 change: 0 additions & 1 deletion content/en/docs/Reference/annotation-processing.md
@@ -1,6 +1,5 @@
---
title: "Annotation Processing"
linkTitle: "Annotation Processing"
weight: 25
description: >
---
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Reference/database-config.md
@@ -1,6 +1,5 @@
---
title: "Database Config"
linkTitle: "Database Config"
weight: 12
description: >
---
Expand Down
9 changes: 4 additions & 5 deletions content/en/docs/Reference/database.md
@@ -1,6 +1,5 @@
---
title: "Database"
linkTitle: "Database"
title: "Databases"
weight: 10
description: >
---
Expand Down Expand Up @@ -45,7 +44,7 @@ val db: JdbcDatabase = JdbcDatabase(
)
```

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

### When using R2DBC {#instantiation-for-r2dbc}

Expand Down Expand Up @@ -118,11 +117,11 @@ val flow: Flow<Address> = db.flow(query)

Database access is made only when the `flow` instance is collected.

See [Query]({{< relref "query.md" >}}) for information on building queries.
See [Queries]({{< relref "Query" >}}) for information on building queries.

### Low-level API execution {#low-level-api-execution}

If the [Query]({{< relref "query.md" >}}) API does not meet your requirements,
If the [Query DSL]({{< relref "Query/QueryDsl" >}}) API does not meet your requirements,
the Low-level APIs are available.

To use the JDBC API directly, call `db.config.session.getConnection()` to get `java.sql.Connection`.
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Reference/dialect.md
@@ -1,6 +1,5 @@
---
title: "Dialect"
linkTitle: "Dialect"
title: "Dialects"
weight: 15
description: >
---
Expand Down
5 changes: 2 additions & 3 deletions content/en/docs/Reference/entity-class.md
@@ -1,6 +1,5 @@
---
title: "Entity Class"
linkTitle: "Entity Class"
title: "Entity Classes"
weight: 20
description: >
---
Expand Down Expand Up @@ -49,7 +48,7 @@ data class Address(
```

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

## Mapping definition {#mapping-definition}

Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Reference/gradle-plugin.md
@@ -1,6 +1,5 @@
---
title: "Gradle Plugin"
linkTitle: "Gradle Plugin"
weight: 200
description: >
---
Expand All @@ -13,7 +12,7 @@ Kotlin source code from database metadata:
- Entity classes
- Mapping definitions

See [Entity Class]({{< relref "entity-class" >}}) for entity classes and mapping definitions.
See [Entity Classes]({{< relref "entity-class" >}}) for entity classes and mapping definitions.

{{< alert title="Note" >}}
Use of this Gradle plugin is not required.
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Reference/logging.md
@@ -1,6 +1,5 @@
---
title: "Logging"
linkTitle: "Logging"
weight: 50
description: >
---
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/Reference/starter.md
@@ -1,6 +1,5 @@
---
title: "Starter"
linkTitle: "Starter"
title: "Starters"
weight: 100
description: >
---
Expand Down
1 change: 0 additions & 1 deletion content/en/docs/Reference/transaction.md
@@ -1,6 +1,5 @@
---
title: "Transaction"
linkTitle: "Transaction"
weight: 40
description: >
---
Expand Down
4 changes: 1 addition & 3 deletions content/ja/docs/Reference/Query/QueryDsl/_index.md
@@ -1,8 +1,6 @@
---
title: "Query DSL"
linkTitle: "Query DSL"
weight: 30
description: >
SQLを組み立てるDSL
description:
---

2 changes: 1 addition & 1 deletion content/ja/docs/Reference/Query/QueryDsl/builder.md
Expand Up @@ -2,7 +2,7 @@
title: "クエリビルダー"
linkTitle: "ビルダー"
weight: 300
description: >
description: クエリの部品を組み立てるAPI
---

## 概要 {#overview}
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/Query/QueryDsl/delete.md
@@ -1,6 +1,6 @@
---
title: "Deleteクエリ"
linkTitle: "Delete"
title: "DELETEクエリ"
linkTitle: "DELETE"
weight: 40
description: >
---
Expand Down
2 changes: 1 addition & 1 deletion content/ja/docs/Reference/Query/QueryDsl/expression.md
Expand Up @@ -2,7 +2,7 @@
title: "クエリの式"
linkTitle: ""
weight: 200
description: >
description: クエリの構成要素を成す式
---

## 概要 {#overview}
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/Query/QueryDsl/insert.md
@@ -1,6 +1,6 @@
---
title: "Insertクエリ"
linkTitle: "Insert"
title: "INSERTクエリ"
linkTitle: "INSERT"
weight: 20
description: >
---
Expand Down
6 changes: 3 additions & 3 deletions content/ja/docs/Reference/Query/QueryDsl/schema.md
@@ -1,9 +1,9 @@
---
title: "Schemaクエリ"
linkTitle: "Schema"
title: "SCHEMAクエリ"
linkTitle: "SCHEMA"
weight: 60
description: >
テーブルの作成や削除のためのクエリ
テーブルスキーマの作成や削除のためのクエリ
---

## 概要 {#overview}
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/Query/QueryDsl/script.md
@@ -1,6 +1,6 @@
---
title: "Scriptクエリ"
linkTitle: "Script"
title: "SCRIPTクエリ"
linkTitle: "SCRIPT"
weight: 60
description: >
任意のSQLスクリプトを表すクエリ
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/Query/QueryDsl/select.md
@@ -1,6 +1,6 @@
---
title: "Selectクエリ"
linkTitle: "Select"
title: "SELECTクエリ"
linkTitle: "SELECT"
weight: 10
description: >
---
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/Query/QueryDsl/template.md
@@ -1,6 +1,6 @@
---
title: "Templateクエリ"
linkTitle: "Template"
title: "TEMPLATEクエリ"
linkTitle: "TEMPLATE"
weight: 50
description: >
SQLテンプレートを利用するクエリ
Expand Down
7 changes: 3 additions & 4 deletions content/ja/docs/Reference/Query/QueryDsl/update.md
@@ -1,9 +1,8 @@
---
title: "Updateクエリ"
linkTitle: "Update"
title: "UPDATEクエリ"
linkTitle: "UPDATE"
weight: 30
description: >
UPDATEクエリ
description:
---

## 概要 {#overview}
Expand Down
3 changes: 1 addition & 2 deletions content/ja/docs/Reference/Query/introduction.md
@@ -1,6 +1,5 @@
---
title: "クエリの紹介"
linkTitle: "紹介"
title: "はじめに"
weight: 1
description: >
---
Expand Down
1 change: 0 additions & 1 deletion content/ja/docs/Reference/annotation-processing.md
@@ -1,6 +1,5 @@
---
title: "アノテーションプロセッシング"
linkTitle: "プロセッシング"
weight: 25
description: >
---
Expand Down
4 changes: 2 additions & 2 deletions content/ja/docs/Reference/database.md
Expand Up @@ -115,11 +115,11 @@ val flow: Flow<Address> = db.flowQuery(query)

データベースへのアクセスは`flowQuery`関数から返される`Flow`インスタンスを利用したときに初めて行われます。

クエリの構築については [クエリ]({{< relref "query.md" >}}) を参照ください。
クエリの構築については [クエリ]({{< relref "Query" >}}) を参照ください。

### 低レベルAPIの実行 {#low-level-api-execution}

[クエリ]({{< relref "query.md" >}}) APIが要件に合わない場合、低レベルAPIを直接利用できます。
[Query DSL]({{< relref "Query/QueryDSL" >}}) のAPIが要件に合わない場合、低レベルAPIを直接利用できます。

JDBCのAPIを直接利用するには、`JdbcDatabase`インスタンスからいくつかのプロパティを呼び出して`java.sql.Connection`を取得します。

Expand Down
9 changes: 5 additions & 4 deletions content/ja/docs/Reference/dialect.md
Expand Up @@ -6,10 +6,11 @@ description: >

## 概要 {#overview}

方言はデータベースやドライバの差異を吸収します
方言の代表的な機能はKotlinとデータベースの型の対応関係を解決することです
ダイアレクトはデータベースやドライバの差異を吸収します
ダイアレクトの代表的な機能はKotlinとデータベースの型の対応関係を解決することです

方言を表すクラスは個別のモジュール(Artifact)に含まれており、どのモジュールを利用するかは接続先データベースや接続タイプに合わせて選択する必要があります。
ダイアレクトを表すクラスは個別のモジュール(Artifact)に含まれており、
どのモジュールを利用するかは接続先データベースや接続タイプに合わせて選択する必要があります。

| Database | Type | Artifact ID | Dialect Class |
|--------------------|:-----:|:---------------------------------:|:----------------------:|
Expand All @@ -24,7 +25,7 @@ description: >
| SQL Server | JDBC | komapper-dialect-sqlserver-jdbc | JdbcSqlServerDialect |
| SQL Server | R2DBC | komapper-dialect-sqlserver-r2dbc | R2dbcSqlServerDialect |

方言を利用するにはGradleの依存関係の宣言の中で上述のArtifact IDを記述します。
ダイアレクトを利用するにはGradleの依存関係の宣言の中で上述のArtifact IDを記述します。

```kotlin
val komapperVersion: String by project
Expand Down
1 change: 0 additions & 1 deletion content/ja/docs/Reference/entity-class.md
@@ -1,6 +1,5 @@
---
title: "エンティティクラス"
linkTitle: "エンティティ"
weight: 20
description: >
---
Expand Down

0 comments on commit cf9ed4f

Please sign in to comment.