Skip to content

Commit 9c9322d

Browse files
actions-useractions-user
committed
Publish docs from commit f7e5751 
0 parents  commit 9c9322d

1,417 files changed

Lines changed: 291383 additions & 0 deletions

File tree

Some content is hidden

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

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

‎_sources/api/catalog.rst.txt‎

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

‎_sources/api/clean.rst.txt‎

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

‎_sources/api/commit.rst.txt‎

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

‎_sources/api/data_types.rst.txt‎

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

‎_sources/api/defs.rst.txt‎

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

0 commit comments

Comments
 (0)