Skip to content

Commit 7e46e0e

Browse files
committed
Publish docs from commit 619fb19
0 parents  commit 7e46e0e

File tree

1,301 files changed

+246870
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,301 files changed

+246870
-0
lines changed

.nojekyll

Whitespace-only changes.

_images/file-layout.png

302 KB
Loading

_images/prefetch.svg

Lines changed: 4 additions & 0 deletions
Loading

_images/sorted-runs.png

177 KB
Loading

_sources/api.rst.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
*************
16+
API Reference
17+
*************
18+
19+
.. toctree::
20+
:maxdepth: 3
21+
22+
api/catalog
23+
api/write
24+
api/commit
25+
api/scan
26+
api/read
27+
api/predicate
28+
api/file_format
29+
api/file_system
30+
api/io
31+
api/data_types
32+
api/file_index
33+
api/global_index
34+
api/clean
35+
api/defs
36+
api/executor
37+
api/memory

_sources/api/catalog.rst.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
===========
16+
Catalog
17+
===========
18+
19+
.. _cpp-api-catalog:
20+
21+
Interface
22+
=========
23+
24+
.. doxygenclass:: paimon::Catalog
25+
:members:
26+
27+
.. doxygenclass:: paimon::Identifier
28+
:members:
29+
:undoc-members:

_sources/api/clean.rst.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
==================
16+
Orphan Files Clean
17+
==================
18+
19+
.. _cpp-api-clean:
20+
21+
Interface
22+
=========
23+
24+
.. doxygenclass:: paimon::OrphanFilesCleaner
25+
:members:
26+
:undoc-members:
27+
28+
.. doxygenclass:: paimon::CleanContextBuilder
29+
:members:
30+
:undoc-members:
31+
32+
.. doxygenclass:: paimon::CleanContext
33+
:members:
34+
:undoc-members:

_sources/api/commit.rst.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
===========
16+
Commit
17+
===========
18+
19+
.. _cpp-api-commit:
20+
21+
Interface
22+
=========
23+
24+
.. doxygenclass:: paimon::FileStoreCommit
25+
:members:
26+
:undoc-members:
27+
28+
.. doxygenclass:: paimon::CommitContextBuilder
29+
:members:
30+
:undoc-members:
31+
32+
.. doxygenclass:: paimon::CommitContext
33+
:members:
34+
:undoc-members:

_sources/api/data_types.rst.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
===========
16+
Data Types
17+
===========
18+
19+
.. _cpp-api-data-types:
20+
21+
Interface
22+
=========
23+
24+
.. doxygenclass:: paimon::Blob
25+
:members:
26+
:undoc-members:
27+
28+
.. doxygenclass:: paimon::Decimal
29+
:members:
30+
:undoc-members:
31+
32+
.. doxygenclass:: paimon::Timestamp
33+
:members:
34+
:undoc-members:

_sources/api/defs.rst.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. Copyright 2024-present Alibaba Inc.
2+
3+
.. Licensed under the Apache License, Version 2.0 (the "License");
4+
.. you may not use this file except in compliance with the License.
5+
.. You may obtain a copy of the License at
6+
7+
.. http://www.apache.org/licenses/LICENSE-2.0
8+
9+
.. Unless required by applicable law or agreed to in writing, software
10+
.. distributed under the License is distributed on an "AS IS" BASIS,
11+
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
.. See the License for the specific language governing permissions and
13+
.. limitations under the License.
14+
15+
===========
16+
Options
17+
===========
18+
19+
.. _cpp-api-options:
20+
21+
Interface
22+
=========
23+
24+
.. doxygenenum:: paimon::FieldType
25+
26+
.. doxygenstruct:: paimon::Options
27+
:members:
28+
:undoc-members:

0 commit comments

Comments
 (0)