Skip to content

Commit 4ad64a9

Browse files
authored
docs: standardize Paimon C++ naming (#168)
1 parent 9277fdf commit 4ad64a9

13 files changed

Lines changed: 40 additions & 40 deletions

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
~ under the License.
1818
-->
1919

20-
# Contributing to Apache Paimon-cpp
20+
# Contributing to Apache Paimon C++
2121

22-
Thank you for your interest in contributing to paimon-cpp! This document explains how to get started.
22+
Thank you for your interest in contributing to Paimon C++! This document explains how to get started.
2323

2424
---
2525

@@ -116,4 +116,4 @@ If you make improvements that could benefit all developers, please update the te
116116

117117
## License
118118

119-
By contributing to paimon-cpp, you agree that your contributions will be licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
119+
By contributing to Paimon C++, you agree that your contributions will be licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
~ under the License.
1818
-->
1919

20-
# Apache Paimon-cpp
20+
# Apache Paimon C++
2121

2222
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
2323

24-
Paimon-cpp is the C++ implementation of [Apache Paimon](https://paimon.apache.org).
24+
Paimon C++ is the C++ implementation of [Apache Paimon](https://paimon.apache.org).
2525
It provides native, high-performance, and extensible access to the Paimon lake format for C++ engines and services without JVM dependencies.
2626

2727
Background and documentation are available at [paimon.apache.org](https://paimon.apache.org).
2828

2929
## Features
3030

31-
Paimon-cpp currently provides:
31+
Paimon C++ currently provides:
3232

3333
- **Write**: append table and primary key table write support with compaction.
3434
- **Commit**: append table commit support for simple append-only tables.
@@ -78,7 +78,7 @@ cp devcontainer.json.template devcontainer.json
7878

7979
## Collaboration
8080

81-
Paimon-cpp is an active open-source project and we welcome people who want to contribute or share good ideas!
81+
Paimon C++ is an active open-source project and we welcome people who want to contribute or share good ideas!
8282
Before contributing, please read the [Contributing Guide](CONTRIBUTING.md) and the [Code Style Guide](docs/code-style.md). You are encouraged to check out our [documentation](https://paimon.apache.org/docs/cpp/).
8383

8484
## License

docs/code-style.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
~ under the License.
1818
-->
1919

20-
# Paimon C++ Code Style Guide
20+
# Apache Paimon C++ Code Style Guide
2121

22-
This document defines the coding conventions for the paimon-cpp project. All pull requests are expected to follow these rules. Automated tooling (clang-format, clang-tidy, cpplint, pre-commit) enforces many of them.
22+
This document defines the coding conventions for the Paimon C++ project. All pull requests are expected to follow these rules. Automated tooling (clang-format, clang-tidy, cpplint, pre-commit) enforces many of them.
2323

2424
---
2525

docs/source/build_system.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
.. default-domain:: cpp
1919
.. highlight:: cpp
2020

21-
======================
22-
Integrating Paimon C++
23-
======================
21+
=============================
22+
Integrating Apache Paimon C++
23+
=============================
2424

2525
This section assumes that you have already built and installed the Paimon C++
2626
libraries on your system after :ref:`building them yourself <building-paimon-cpp>`.

docs/source/building.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
.. _building-paimon-cpp:
2121

22-
===================
23-
Building Paimon C++
24-
===================
22+
==========================
23+
Building Apache Paimon C++
24+
==========================
2525

2626
System setup
2727
============

docs/source/getting_started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Getting Started
2222
===============
2323

2424
The following articles demonstrate installation, usage, and a basic
25-
understanding of C++ Paimon. These articles will get you set up quickly with C++
26-
Paimon and give you a taste of what the library is capable of.
25+
understanding of Paimon C++. These articles will get you set up quickly with
26+
Paimon C++ and give you a taste of what the library is capable of.
2727

2828
Start here to gain a basic understanding of Paimon, and move on to the
2929
:doc:`/user_guide` to explore more specific topics and

docs/source/user_guide/catalog.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@
1919

2020
Catalog
2121
==========================
22-
C++ Paimon provides a :ref:`Catalog abstraction <cpp-api-catalog>` to manage the table of contents and metadata. The Catalog
22+
Paimon C++ provides a :ref:`Catalog abstraction <cpp-api-catalog>` to manage the table of contents and metadata. The Catalog
2323
abstraction provides a series of ways to help you better integrate with computing engines. We always
2424
recommend that you use Catalog to access the Paimon table.
2525

2626
Filesystem Catalog
2727
~~~~~~~~~~~~~~~~~~
28-
C++ Paimon catalog currently support one types of metastores filesystem metastore (default),
28+
Paimon C++ catalog currently support one types of metastores filesystem metastore (default),
2929
which stores both metadata and table files in filesystems.
3030

3131
.. note::
3232

33-
Current C++ Paimon only supports filesystem catalog. In the future, we will
33+
Current Paimon C++ only supports filesystem catalog. In the future, we will
3434
support REST catalog.
3535
By using the Paimon REST catalog, changes to the catalog will be directly stored
3636
in a remote catalog server which exposed through REST API. See `Java Paimon REST

docs/source/user_guide/compaction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ compaction is therefore a trade-off between write throughput and read efficiency
2626
.. note::
2727
- There can only be one job working on the same partition's compaction,
2828
otherwise it will cause conflicts.
29-
- C++ Paimon does not support producing changelog for now.
29+
- Paimon C++ does not support producing changelog for now.
3030
- Compaction is disabled when ``write-only`` is set to ``true``, or when the
3131
table uses dynamic bucketing (``bucket = -1``) for append-only tables.
3232
- For a complete list of compaction-related configurations, see the

docs/source/user_guide/data_types.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Data Types
2121
A data type describes the logical type of a value in the table ecosystem. It can
2222
be used to declare input and/or output types of operations.
2323

24-
All data types by Java Paimon are as follows, C++ Paimon uses Apache Arrow as
24+
All data types by Java Paimon are as follows, Paimon C++ uses Apache Arrow as
2525
its schema representation. The following table shows the mapping between `Java
2626
Paimon DataTypes <https://paimon.apache.org/docs/master/concepts/data-types/>`_
2727
and `Arrow DataTypes <https://arrow.apache.org/docs/format/Columnar.html#data-types>`_:
@@ -194,7 +194,7 @@ and `Arrow DataTypes <https://arrow.apache.org/docs/format/Columnar.html#data-ty
194194

195195
The type can be declared using ``MAP<kt, vt>`` where kt is the data type of the key elements and vt is the data type of the value elements.
196196

197-
**Note:** In C++ Paimon, map keys must be explicitly marked as ``NOT NULL``.
197+
**Note:** In Paimon C++, map keys must be explicitly marked as ``NOT NULL``.
198198
Apache Arrow does not support nullable map keys. If the key type is not
199199
marked as ``NOT NULL`` in the schema, parsing will fail with an error.
200200

@@ -234,7 +234,7 @@ and `Arrow DataTypes <https://arrow.apache.org/docs/format/Columnar.html#data-ty
234234
Variant values are encoded with two binaries following the parquet-format
235235
`Variant Binary Encoding <https://github.com/apache/parquet-format/blob/master/VariantEncoding.md>`_
236236
specification (compatible with the Java Paimon / Spark implementation). In
237-
C++ Paimon, a variant field is represented in an Arrow schema as
237+
Paimon C++, a variant field is represented in an Arrow schema as
238238
``Struct{value: Binary NOT NULL, metadata: Binary NOT NULL}`` marked with
239239
Paimon-specific field metadata; use ``paimon::Variant::ArrowField`` to
240240
construct such a field, and ``paimon::Variant`` (``FromJson``/``ToJson``/

docs/source/user_guide/manifest_cache.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Manifest Cache
2121
Overview
2222
--------
2323

24-
paimon-cpp caches raw manifest file bytes at the ``ObjectsFile<T>::Read()``
24+
Paimon C++ caches raw manifest file bytes at the ``ObjectsFile<T>::Read()``
2525
layer. The cache uses the public ``Cache`` abstraction and is enabled through
2626
``ScanContextBuilder::WithCache()``. The cache covers data manifests, manifest
2727
lists, and index manifests because they all read through ``ObjectsFile<T>``.

0 commit comments

Comments
 (0)