This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new c915a40af [doc] Move tables from concepts to top level
c915a40af is described below
commit c915a40affb07a4ea384f4ad2d485ece3bb1c3b4
Author: Jingsong <[email protected]>
AuthorDate: Wed Apr 3 15:32:55 2024 +0800
[doc] Move tables from concepts to top level
---
.../{cdc-ingestion => append-table}/_index.md | 4 ++--
.../append-table/append-queue-table.md | 2 +-
.../append-table/append-scalable-table.md | 2 +-
.../{concepts => }/append-table/overview.md | 4 ++--
docs/content/cdc-ingestion/_index.md | 2 +-
docs/content/concepts/append-table/_index.md | 23 ----------------------
docs/content/concepts/primary-key-table/_index.md | 23 ----------------------
docs/content/engines/_index.md | 2 +-
docs/content/engines/spark.md | 4 ++--
docs/content/filesystems/_index.md | 2 +-
docs/content/how-to/_index.md | 2 +-
docs/content/how-to/creating-tables.md | 2 +-
docs/content/how-to/writing-tables.md | 10 +++++-----
docs/content/learn-paimon/_index.md | 2 +-
docs/content/learn-paimon/understand-files.md | 4 ++--
docs/content/maintenance/_index.md | 2 +-
docs/content/maintenance/dedicated-compaction.md | 4 ++--
docs/content/maintenance/write-performance.md | 4 ++--
docs/content/migration/_index.md | 2 +-
docs/content/migration/migration-from-hive.md | 2 +-
.../{cdc-ingestion => primary-key-table}/_index.md | 4 ++--
.../primary-key-table/changelog-producer.md | 2 +-
.../primary-key-table/data-distribution.md | 4 ++--
.../primary-key-table/deletion-vectors.md | 2 +-
.../primary-key-table/merge-engine.md | 12 +++++------
.../{concepts => }/primary-key-table/overview.md | 8 ++++----
.../primary-key-table/read-optimized.md | 4 ++--
.../primary-key-table/sequence-rowkind.md | 2 +-
docs/content/program-api/_index.md | 2 +-
docs/content/project/_index.md | 2 +-
30 files changed, 49 insertions(+), 95 deletions(-)
diff --git a/docs/content/cdc-ingestion/_index.md
b/docs/content/append-table/_index.md
similarity index 96%
copy from docs/content/cdc-ingestion/_index.md
copy to docs/content/append-table/_index.md
index c22e5db75..9848375b9 100644
--- a/docs/content/cdc-ingestion/_index.md
+++ b/docs/content/append-table/_index.md
@@ -1,9 +1,9 @@
---
-title: CDC Ingestion
+title: "Table w/o PK"
icon: <i class="fa fa-database title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 5
+weight: 3
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/append-table/append-queue-table.md
b/docs/content/append-table/append-queue-table.md
similarity index 99%
rename from docs/content/concepts/append-table/append-queue-table.md
rename to docs/content/append-table/append-queue-table.md
index 37860b774..3d3e3f22e 100644
--- a/docs/content/concepts/append-table/append-queue-table.md
+++ b/docs/content/append-table/append-queue-table.md
@@ -3,7 +3,7 @@ title: "Append Queue Table"
weight: 3
type: docs
aliases:
-- /concepts/append-table/append-queue-table.html
+- /append-table/append-queue-table.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/append-table/append-scalable-table.md
b/docs/content/append-table/append-scalable-table.md
similarity index 99%
rename from docs/content/concepts/append-table/append-scalable-table.md
rename to docs/content/append-table/append-scalable-table.md
index f83f1cd67..f2b80c202 100644
--- a/docs/content/concepts/append-table/append-scalable-table.md
+++ b/docs/content/append-table/append-scalable-table.md
@@ -3,7 +3,7 @@ title: "Append Scalable Table"
weight: 2
type: docs
aliases:
-- /concepts/append-table/append-scalable-table.html
+- /append-table/append-scalable-table.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/append-table/overview.md
b/docs/content/append-table/overview.md
similarity index 86%
rename from docs/content/concepts/append-table/overview.md
rename to docs/content/append-table/overview.md
index ff07be997..5c0f4c560 100644
--- a/docs/content/concepts/append-table/overview.md
+++ b/docs/content/append-table/overview.md
@@ -3,7 +3,7 @@ title: "Overview"
weight: 1
type: docs
aliases:
-- /concepts/append-table/overview.html
+- /append-table/overview.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -32,5 +32,5 @@ You can only insert a complete record into the table in
streaming. This type of
do not require streaming updates (such as log data synchronization).
{{< hint info >}}
-We highly recommend using [Append Scalable Table]({{< ref
"concepts/append-table/append-scalable-table" >}}). (bucket = -1).
+We highly recommend using [Append Scalable Table]({{< ref
"append-table/append-scalable-table" >}}). (bucket = -1).
{{< /hint >}}
\ No newline at end of file
diff --git a/docs/content/cdc-ingestion/_index.md
b/docs/content/cdc-ingestion/_index.md
index c22e5db75..b82d4d760 100644
--- a/docs/content/cdc-ingestion/_index.md
+++ b/docs/content/cdc-ingestion/_index.md
@@ -3,7 +3,7 @@ title: CDC Ingestion
icon: <i class="fa fa-database title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 5
+weight: 94
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/append-table/_index.md
b/docs/content/concepts/append-table/_index.md
deleted file mode 100644
index f7c1b4272..000000000
--- a/docs/content/concepts/append-table/_index.md
+++ /dev/null
@@ -1,23 +0,0 @@
----
-title: "Append Table"
-bookCollapseSection: true
-weight: 7
----
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
diff --git a/docs/content/concepts/primary-key-table/_index.md
b/docs/content/concepts/primary-key-table/_index.md
deleted file mode 100644
index cd2b8a745..000000000
--- a/docs/content/concepts/primary-key-table/_index.md
+++ /dev/null
@@ -1,23 +0,0 @@
----
-title: "Primary Key Table"
-bookCollapseSection: true
-weight: 6
----
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
diff --git a/docs/content/engines/_index.md b/docs/content/engines/_index.md
index f1cc98169..fda12cf31 100644
--- a/docs/content/engines/_index.md
+++ b/docs/content/engines/_index.md
@@ -3,7 +3,7 @@ title: Engines
icon: <i class="fa fa-gear title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 2
+weight: 4
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/engines/spark.md b/docs/content/engines/spark.md
index ef3ffb429..127c4fdcd 100644
--- a/docs/content/engines/spark.md
+++ b/docs/content/engines/spark.md
@@ -231,8 +231,8 @@ dataset.show()
{{< hint info >}}
Important table properties setting:
-1. Only [primary key table]({{< ref "concepts/primary-key-table" >}}) supports
this feature.
-2. [MergeEngine]({{< ref "concepts/primary-key-table/merge-engine" >}}) needs
to be [deduplicate]({{< ref "concepts/primary-key-table#deduplicate" >}}) or
[partial-update]({{< ref
"concepts/primary-key-table/merge-engine#partial-update" >}}) to support this
feature.
+1. Only [primary key table]({{< ref "primary-key-table" >}}) supports this
feature.
+2. [MergeEngine]({{< ref "primary-key-table/merge-engine" >}}) needs to be
[deduplicate]({{< ref "primary-key-table#deduplicate" >}}) or
[partial-update]({{< ref "primary-key-table/merge-engine#partial-update" >}})
to support this feature.
{{< /hint >}}
{{< hint warning >}}
diff --git a/docs/content/filesystems/_index.md
b/docs/content/filesystems/_index.md
index afc10a7dd..37fb9791f 100644
--- a/docs/content/filesystems/_index.md
+++ b/docs/content/filesystems/_index.md
@@ -3,7 +3,7 @@ title: Filesystems
icon: <i class="fa fa-folder title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 3
+weight: 92
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/how-to/_index.md b/docs/content/how-to/_index.md
index 9178c6336..ff14a9e1f 100644
--- a/docs/content/how-to/_index.md
+++ b/docs/content/how-to/_index.md
@@ -3,7 +3,7 @@ title: How to
icon: <i class="fa fa-database title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 4
+weight: 91
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/how-to/creating-tables.md
b/docs/content/how-to/creating-tables.md
index bad9d418f..9dc0973a7 100644
--- a/docs/content/how-to/creating-tables.md
+++ b/docs/content/how-to/creating-tables.md
@@ -224,7 +224,7 @@ By configuring [partition.expiration-time]({{< ref
"maintenance/manage-partition
#### Pick Partition Fields
{{< hint info >}}
-If you need cross partition upsert (primary keys not contain all partition
fields), see [Cross partition Upsert]({{< ref
"concepts/primary-key-table/data-distribution#cross-partitions-upsert-dynamic-bucket-mode">}})
mode.
+If you need cross partition upsert (primary keys not contain all partition
fields), see [Cross partition Upsert]({{< ref
"primary-key-table/data-distribution#cross-partitions-upsert-dynamic-bucket-mode">}})
mode.
{{< /hint >}}
The following three types of fields may be defined as partition fields in the
warehouse:
diff --git a/docs/content/how-to/writing-tables.md
b/docs/content/how-to/writing-tables.md
index c70ae79bd..35b9f0b2f 100644
--- a/docs/content/how-to/writing-tables.md
+++ b/docs/content/how-to/writing-tables.md
@@ -332,8 +332,8 @@ For more information of drop_partition, see
{{< hint info >}}
Important table properties setting:
-1. Only [primary key table]({{< ref "concepts/primary-key-table" >}}) supports
this feature.
-2. [MergeEngine]({{< ref "concepts/primary-key-table/merge-engine" >}}) needs
to be [deduplicate]({{< ref
"concepts/primary-key-table/merge-engine#deduplicate" >}}) or
[partial-update]({{< ref
"concepts/primary-key-table/merge-engine#partial-update" >}}) to support this
feature.
+1. Only [primary key table]({{< ref "primary-key-table" >}}) supports this
feature.
+2. [MergeEngine]({{< ref "primary-key-table/merge-engine" >}}) needs to be
[deduplicate]({{< ref "primary-key-table/merge-engine#deduplicate" >}}) or
[partial-update]({{< ref "primary-key-table/merge-engine#partial-update" >}})
to support this feature.
{{< /hint >}}
{{< hint warning >}}
@@ -439,7 +439,7 @@ For more information of 'delete', see
{{< hint info >}}
Important table properties setting:
1. Only primary key tables support this feature.
-2. If the table has primary keys, [MergeEngine]({{< ref
"concepts/primary-key-table/merge-engine" >}}) needs to be [deduplicate]({{<
ref "concepts/primary-key-table/merge-engine#deduplicate" >}}) to support this
feature.
+2. If the table has primary keys, [MergeEngine]({{< ref
"primary-key-table/merge-engine" >}}) needs to be [deduplicate]({{< ref
"primary-key-table/merge-engine#deduplicate" >}}) to support this feature.
{{< /hint >}}
{{< hint warning >}}
@@ -472,7 +472,7 @@ DELETE FROM my_table WHERE currency = 'UNKNOWN';
{{< hint info >}}
Important table properties setting:
1. Only primary key tables support this feature.
-2. If the table has primary keys, [MergeEngine]({{< ref
"concepts/primary-key-table#merge-engines" >}}) needs to be [deduplicate]({{<
ref "concepts/primary-key-table#deduplicate" >}}) to support this feature.
+2. If the table has primary keys, [MergeEngine]({{< ref
"primary-key-table#merge-engines" >}}) needs to be [deduplicate]({{< ref
"primary-key-table#deduplicate" >}}) to support this feature.
{{< /hint >}}
To enable delete needs these configs below:
@@ -495,7 +495,7 @@ Paimon supports "MERGE INTO" via submitting the
'merge_into' job through `flink
{{< hint info >}}
Important table properties setting:
-1. Only [primary key table]({{< ref "concepts/primary-key-table" >}}) supports
this feature.
+1. Only [primary key table]({{< ref "primary-key-table" >}}) supports this
feature.
2. The action won't produce UPDATE_BEFORE, so it's not recommended to set
'changelog-producer' = 'input'.
{{< /hint >}}
diff --git a/docs/content/learn-paimon/_index.md
b/docs/content/learn-paimon/_index.md
index 9fa906127..865fcb659 100644
--- a/docs/content/learn-paimon/_index.md
+++ b/docs/content/learn-paimon/_index.md
@@ -3,7 +3,7 @@ title: Learn Paimon
icon: <i class="fa fa-sitemap title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 10
+weight: 99
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/learn-paimon/understand-files.md
b/docs/content/learn-paimon/understand-files.md
index aa8aa6ec7..7e06e483d 100644
--- a/docs/content/learn-paimon/understand-files.md
+++ b/docs/content/learn-paimon/understand-files.md
@@ -40,7 +40,7 @@ Before delving further into this page, please ensure that you
have read through
following sections:
1. [Basic Concepts]({{< ref "concepts/basic-concepts" >}}),
-2. [Primary Key Table]({{< ref "concepts/primary-key-table/overview" >}}) and
+2. [Primary Key Table]({{< ref "primary-key-table/overview" >}}) and
3. How to use Paimon in [Flink]({{< ref "engines/flink" >}}).
## Understand File Operations
@@ -455,7 +455,7 @@ this means that there are at least 5 files in a bucket. If
you want to reduce th
By default, Append also does automatic compaction to reduce the number of
small files.
However, for Bucket's Append table, it will only compact the files within the
Bucket for sequential
-purposes, which may keep more small files. See [Append Queue Table]({{< ref
"/concepts/append-table/append-queue-table" >}}).
+purposes, which may keep more small files. See [Append Queue Table]({{< ref
"append-table/append-queue-table" >}}).
### Understand Full-Compaction
diff --git a/docs/content/maintenance/_index.md
b/docs/content/maintenance/_index.md
index d148bf67b..bfea9b72f 100644
--- a/docs/content/maintenance/_index.md
+++ b/docs/content/maintenance/_index.md
@@ -3,7 +3,7 @@ title: Maintenance
icon: <i class="fa fa-wrench title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 6
+weight: 95
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/maintenance/dedicated-compaction.md
b/docs/content/maintenance/dedicated-compaction.md
index c4d9de2f1..c9bcb5214 100644
--- a/docs/content/maintenance/dedicated-compaction.md
+++ b/docs/content/maintenance/dedicated-compaction.md
@@ -223,8 +223,8 @@ For more usage of the compact_database action, see
## Sort Compact
-If your table is configured with [dynamic bucket primary key table]({{< ref
"concepts/primary-key-table/data-distribution#dynamic-bucket" >}})
-or [unaware bucket append table]({{< ref
"concepts/append-table/append-scalable-table" >}}) ,
+If your table is configured with [dynamic bucket primary key table]({{< ref
"primary-key-table/data-distribution#dynamic-bucket" >}})
+or [unaware bucket append table]({{< ref "append-table/append-scalable-table"
>}}) ,
you can trigger a compact with specified column sort to speed up queries.
```bash
diff --git a/docs/content/maintenance/write-performance.md
b/docs/content/maintenance/write-performance.md
index 1386e5858..bb4094793 100644
--- a/docs/content/maintenance/write-performance.md
+++ b/docs/content/maintenance/write-performance.md
@@ -143,9 +143,9 @@ Its value depends on your memory size.
### Number of Sorted Runs to Trigger Compaction
-Paimon uses [LSM tree]({{< ref "concepts/primary-key-table/overview#lsm-trees"
>}}) which supports a large number of updates. LSM organizes files in several
[sorted runs]({{< ref "concepts/primary-key-table/overview#sorted-runs" >}}).
When querying records from an LSM tree, all sorted runs must be combined to
produce a complete view of all records.
+Paimon uses [LSM tree]({{< ref "primary-key-table/overview#lsm-trees" >}})
which supports a large number of updates. LSM organizes files in several
[sorted runs]({{< ref "primary-key-table/overview#sorted-runs" >}}). When
querying records from an LSM tree, all sorted runs must be combined to produce
a complete view of all records.
-One can easily see that too many sorted runs will result in poor query
performance. To keep the number of sorted runs in a reasonable range, Paimon
writers will automatically perform [compactions]({{< ref
"concepts/primary-key-table/overview#compaction" >}}). The following table
property determines the minimum number of sorted runs to trigger a compaction.
+One can easily see that too many sorted runs will result in poor query
performance. To keep the number of sorted runs in a reasonable range, Paimon
writers will automatically perform [compactions]({{< ref
"primary-key-table/overview#compaction" >}}). The following table property
determines the minimum number of sorted runs to trigger a compaction.
<table class="table table-bordered">
<thead>
diff --git a/docs/content/migration/_index.md b/docs/content/migration/_index.md
index 3da339e38..64ac60499 100644
--- a/docs/content/migration/_index.md
+++ b/docs/content/migration/_index.md
@@ -3,7 +3,7 @@ title: Migration
icon: <i class="fa fa-briefcase title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 8
+weight: 97
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/migration/migration-from-hive.md
b/docs/content/migration/migration-from-hive.md
index 92b9e4c64..4f0383625 100644
--- a/docs/content/migration/migration-from-hive.md
+++ b/docs/content/migration/migration-from-hive.md
@@ -28,7 +28,7 @@ under the License.
Apache Hive supports ORC, Parquet file formats that could be migrated to
Paimon.
When migrating data to a paimon table, the origin table will be permanently
disappeared. So please back up your data if you
-still need the original table. The migrated table will be [unaware-bucket
append table]({{< ref "concepts/append-table/append-scalable-table" >}}).
+still need the original table. The migrated table will be [unaware-bucket
append table]({{< ref "append-table/append-scalable-table" >}}).
Now, we can use paimon hive catalog with Migrate Table Procedure and Migrate
File Procedure to totally migrate a table from hive to paimon.
At the same time, you can use paimon hive catalog with Migrate Database
Procedure to fully synchronize all tables in the database to paimon.
diff --git a/docs/content/cdc-ingestion/_index.md
b/docs/content/primary-key-table/_index.md
similarity index 96%
copy from docs/content/cdc-ingestion/_index.md
copy to docs/content/primary-key-table/_index.md
index c22e5db75..f84883b68 100644
--- a/docs/content/cdc-ingestion/_index.md
+++ b/docs/content/primary-key-table/_index.md
@@ -1,9 +1,9 @@
---
-title: CDC Ingestion
+title: "Table with PK"
icon: <i class="fa fa-database title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 5
+weight: 2
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/primary-key-table/changelog-producer.md
b/docs/content/primary-key-table/changelog-producer.md
similarity index 99%
rename from docs/content/concepts/primary-key-table/changelog-producer.md
rename to docs/content/primary-key-table/changelog-producer.md
index f0b132e5b..3ddfbf158 100644
--- a/docs/content/concepts/primary-key-table/changelog-producer.md
+++ b/docs/content/primary-key-table/changelog-producer.md
@@ -3,7 +3,7 @@ title: "Changelog Producer"
weight: 4
type: docs
aliases:
-- /concepts/primary-key-table/changelog-producer.html
+- /primary-key-table/changelog-producer.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/primary-key-table/data-distribution.md
b/docs/content/primary-key-table/data-distribution.md
similarity index 96%
rename from docs/content/concepts/primary-key-table/data-distribution.md
rename to docs/content/primary-key-table/data-distribution.md
index e0ed5fd57..75f325f62 100644
--- a/docs/content/concepts/primary-key-table/data-distribution.md
+++ b/docs/content/primary-key-table/data-distribution.md
@@ -3,7 +3,7 @@ title: "Data Distribution"
weight: 2
type: docs
aliases:
-- /concepts/primary-key-table/data-distribution.html
+- /primary-key-table/data-distribution.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -31,7 +31,7 @@ By default, Paimon table only has one bucket, which means it
only provides singl
Please configure the bucket strategy to your table.
{{< /hint >}}
-A bucket is the smallest storage unit for reads and writes, each bucket
directory contains an [LSM tree]({{< ref
"concepts/primary-key-table/overview#lsm-trees" >}}).
+A bucket is the smallest storage unit for reads and writes, each bucket
directory contains an [LSM tree]({{< ref "primary-key-table/overview#lsm-trees"
>}}).
## Fixed Bucket
diff --git a/docs/content/concepts/primary-key-table/deletion-vectors.md
b/docs/content/primary-key-table/deletion-vectors.md
similarity index 97%
rename from docs/content/concepts/primary-key-table/deletion-vectors.md
rename to docs/content/primary-key-table/deletion-vectors.md
index a726b5f26..dbadffe6d 100644
--- a/docs/content/concepts/primary-key-table/deletion-vectors.md
+++ b/docs/content/primary-key-table/deletion-vectors.md
@@ -3,7 +3,7 @@ title: "Deletion Vectors"
weight: 6
type: docs
aliases:
-- /concepts/primary-key-table/deletion-vectors.html
+- /primary-key-table/deletion-vectors.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/concepts/primary-key-table/merge-engine.md
b/docs/content/primary-key-table/merge-engine.md
similarity index 94%
rename from docs/content/concepts/primary-key-table/merge-engine.md
rename to docs/content/primary-key-table/merge-engine.md
index 5e87c4f76..bc6c1ee35 100644
--- a/docs/content/concepts/primary-key-table/merge-engine.md
+++ b/docs/content/primary-key-table/merge-engine.md
@@ -3,7 +3,7 @@ title: "Merge Engine"
weight: 3
type: docs
aliases:
-- /concepts/primary-key-table/merge-engine.html
+- /primary-key-table/merge-engine.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -31,7 +31,7 @@ When Paimon sink receives two or more records with the same
primary keys, it wil
{{< hint info >}}
Always set `table.exec.sink.upsert-materialize` to `NONE` in Flink SQL
TableConfig, sink upsert-materialize may
result in strange behavior. When the input is out of order, we recommend that
you use
-[Sequence Field]({{< ref
"concepts/primary-key-table/sequence-rowkind#sequence-field" >}}) to correct
disorder.
+[Sequence Field]({{< ref "primary-key-table/sequence-rowkind#sequence-field"
>}}) to correct disorder.
{{< /hint >}}
## Deduplicate
@@ -54,7 +54,7 @@ Assuming that the first column is the primary key, the final
result would be `<1
{{< hint info >}}
For streaming queries, `partial-update` merge engine must be used together
with `lookup` or `full-compaction`
-[changelog producer]({{< ref "concepts/primary-key-table/changelog-producer"
>}}). ('input' changelog producer is also supported, but only returns input
records.)
+[changelog producer]({{< ref "primary-key-table/changelog-producer" >}}).
('input' changelog producer is also supported, but only returns input records.)
{{< /hint >}}
{{< hint info >}}
@@ -108,7 +108,7 @@ For `fields.<field-name>.sequence-group`, valid comparative
data types include:
### Aggregation For Partial Update
-You can specify aggregation function for the input field, all the functions in
the [Aggregation]({{< ref "concepts/primary-key-table/merge-engine#aggregation"
>}}) are supported.
+You can specify aggregation function for the input field, all the functions in
the [Aggregation]({{< ref "primary-key-table/merge-engine#aggregation" >}}) are
supported.
See example:
@@ -297,7 +297,7 @@ Current supported aggregate functions and data types are:
{{< hint info >}}
For streaming queries, `aggregation` merge engine must be used together with
`lookup` or `full-compaction`
-[changelog producer]({{< ref "concepts/primary-key-table/changelog-producer"
>}}). ('input' changelog producer is also supported, but only returns input
records.)
+[changelog producer]({{< ref "primary-key-table/changelog-producer" >}}).
('input' changelog producer is also supported, but only returns input records.)
{{< /hint >}}
### Retract
@@ -326,7 +326,7 @@ By specifying `'merge-engine' = 'first-row'`, users can
keep the first row of th
`deduplicate` merge engine that in the `first-row` merge engine, it will
generate insert only changelog.
{{< hint info >}}
-1. `first-row` merge engine must be used together with `lookup` [changelog
producer]({{< ref "concepts/primary-key-table/changelog-producer" >}}).
+1. `first-row` merge engine must be used together with `lookup` [changelog
producer]({{< ref "primary-key-table/changelog-producer" >}}).
2. You can not specify `sequence.field`.
3. Not accept `DELETE` and `UPDATE_BEFORE` message. You can config
`ignore-delete` to ignore these two kinds records.
{{< /hint >}}
diff --git a/docs/content/concepts/primary-key-table/overview.md
b/docs/content/primary-key-table/overview.md
similarity index 92%
rename from docs/content/concepts/primary-key-table/overview.md
rename to docs/content/primary-key-table/overview.md
index bcd1c24c5..b51597c12 100644
--- a/docs/content/concepts/primary-key-table/overview.md
+++ b/docs/content/primary-key-table/overview.md
@@ -3,7 +3,7 @@ title: "Overview"
weight: 1
type: docs
aliases:
-- /concepts/primary-key-table/overview.html
+- /primary-key-table/overview.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -26,7 +26,7 @@ under the License.
# Overview
-Primary key table is the default table type when creating a table. Users can
insert, update or delete records in the table.
+If you define a table with primary key, you can insert, update or delete
records in the table.
Primary keys consist of a set of columns that contain unique values for each
record. Paimon enforces data ordering by
sorting the primary key within each bucket, allowing users to achieve high
performance by applying filtering conditions
@@ -36,7 +36,7 @@ on the primary key. See [CREATE TABLE]({{< ref
"how-to/creating-tables" >}}).
Unpartitioned tables, or partitions in partitioned tables, are sub-divided
into buckets, to provide extra structure to the data that may be used for more
efficient querying.
-Each bucket directory contains an LSM tree and its [changelog files]({{< ref
"concepts/primary-key-table/changelog-producer" >}}).
+Each bucket directory contains an LSM tree and its [changelog files]({{< ref
"primary-key-table/changelog-producer" >}}).
The range for a bucket is determined by the hash value of one or more columns
in the records. Users can specify bucketing columns by providing the
[`bucket-key` option]({{< ref "maintenance/configurations#coreoptions" >}}). If
no `bucket-key` option is specified, the primary key (if defined) or the
complete record will be used as the bucket key.
@@ -56,7 +56,7 @@ Records within a data file are sorted by their primary keys.
Within a sorted run
{{< img src="/img/sorted-runs.png">}}
-As you can see, different sorted runs may have overlapping primary key ranges,
and may even contain the same primary key. When querying the LSM tree, all
sorted runs must be combined and all records with the same primary key must be
merged according to the user-specified [merge engine]({{< ref
"concepts/primary-key-table/merge-engine" >}}) and the timestamp of each record.
+As you can see, different sorted runs may have overlapping primary key ranges,
and may even contain the same primary key. When querying the LSM tree, all
sorted runs must be combined and all records with the same primary key must be
merged according to the user-specified [merge engine]({{< ref
"primary-key-table/merge-engine" >}}) and the timestamp of each record.
New records written into the LSM tree will be first buffered in memory. When
the memory buffer is full, all records in memory will be sorted and flushed to
disk. A new sorted run is now created.
diff --git a/docs/content/concepts/primary-key-table/read-optimized.md
b/docs/content/primary-key-table/read-optimized.md
similarity index 92%
rename from docs/content/concepts/primary-key-table/read-optimized.md
rename to docs/content/primary-key-table/read-optimized.md
index 7be681124..d8b2b5f28 100644
--- a/docs/content/concepts/primary-key-table/read-optimized.md
+++ b/docs/content/primary-key-table/read-optimized.md
@@ -3,7 +3,7 @@ title: "Read Optimized"
weight: 7
type: docs
aliases:
-- /concepts/primary-key-table/read-optimized.html
+- /primary-key-table/read-optimized.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -32,7 +32,7 @@ For Primary Key Table, it's a 'MergeOnRead' technology. When
reading data, multi
and the number of parallelism will be limited by the number of buckets.
Although Paimon's merge performance is efficient,
it still cannot catch up with the ordinary AppendOnly table.
-We recommend that you use [Deletion Vectors]({{< ref
"concepts/primary-key-table/deletion-vectors" >}}) mode.
+We recommend that you use [Deletion Vectors]({{< ref
"primary-key-table/deletion-vectors" >}}) mode.
If you don't want to use Deletion Vectors mode, you want to query fast enough
in certain scenarios, but can only find
older data, you can also:
diff --git a/docs/content/concepts/primary-key-table/sequence-rowkind.md
b/docs/content/primary-key-table/sequence-rowkind.md
similarity index 97%
rename from docs/content/concepts/primary-key-table/sequence-rowkind.md
rename to docs/content/primary-key-table/sequence-rowkind.md
index 65df770bb..07248941e 100644
--- a/docs/content/concepts/primary-key-table/sequence-rowkind.md
+++ b/docs/content/primary-key-table/sequence-rowkind.md
@@ -3,7 +3,7 @@ title: "Sequence & Rowkind"
weight: 5
type: docs
aliases:
-- /concepts/primary-key-table/sequence-rowkind.html
+- /primary-key-table/sequence-rowkind.html
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/program-api/_index.md
b/docs/content/program-api/_index.md
index a40d1dc87..c5ba04fc0 100644
--- a/docs/content/program-api/_index.md
+++ b/docs/content/program-api/_index.md
@@ -3,7 +3,7 @@ title: Program API
icon: <i class="fa fa-briefcase title maindish" aria-hidden="true"></i>
bold: true
bookCollapseSection: true
-weight: 7
+weight: 96
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
diff --git a/docs/content/project/_index.md b/docs/content/project/_index.md
index 84aee3057..96c5f097a 100644
--- a/docs/content/project/_index.md
+++ b/docs/content/project/_index.md
@@ -4,7 +4,7 @@ icon: <i class="fa fa-sitemap title maindish"
aria-hidden="true"></i>
bold: true
bookCollapseSection: true
sectionBreak: true
-weight: 9
+weight: 98
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
