MCPcopy Index your code
hub / github.com/apache/paimon

github.com/apache/paimon @release-1.4.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release release-1.4.2 ↗ · + Follow
42,482 symbols 247,621 edges 4,266 files 8,583 documented · 20%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Paimon

License Get on Slack

Apache Paimon is a lake format that enables building a Realtime Lakehouse Architecture with Flink and Spark for both streaming and batch operations. Paimon innovatively combines lake format and LSM structure, bringing realtime streaming updates into the lake architecture.

Background and documentation are available at https://paimon.apache.org

Paimon's former name was Flink Table Store, developed from the Flink community. The architecture refers to some design concepts of Iceberg. Thanks to Apache Flink and Apache Iceberg.

Collaboration

Paimon tracks issues in GitHub and prefers to receive contributions as pull requests.

Mailing Lists

Name Subscribe Digest Unsubscribe Post Archive
user@paimon.apache.org User support and questions mailing list Subscribe Subscribe Unsubscribe Post Archives
dev@paimon.apache.org Development related discussions Subscribe Subscribe Unsubscribe Post Archives

Please make sure you are subscribed to the mailing list you are posting to! If you are not subscribed to the mailing list, your message will either be rejected (dev@ list) or you won't receive the response (user@ list).

Slack

You can join the Paimon community on Slack. Paimon channel is in ASF Slack workspace.

  • Anyone with an @apache.org email address can become a full member of the ASF Slack workspace. Search Paimon channel and join it.
  • If you don't have an @apache.org email address, you can email to user@paimon.apache.org to apply for an ASF Slack invitation. Then join Paimon channel.

Building

JDK 8/11 is required for building the project. Maven version >=3.6.3.

  • Run the mvn clean install -DskipTests command to build the project.
  • Run the mvn spotless:apply to format the project (both Java and Scala).
  • IDE: Mark paimon-common/target/generated-sources/antlr4 as Sources Root.

How to Contribute

Contribution Guide.

License

The code in this repository is licensed under the Apache Software License 2.

Extension points exported contracts — how you extend this code

E2eQueryExecutor (Interface)
E2e query executor for testing. [17 implementers]
paimon-e2e-tests/src/test/java/org/apache/paimon/tests/E2eQueryExecutor.java
DataTypeVisitor (Interface)
The visitor definition of DataType. The visitor transforms a data type into instances of R. @param [80 implementers]
paimon-api/src/main/java/org/apache/paimon/types/DataTypeVisitor.java
JdbcToPaimonTypeVisitor (Interface)
jdbc to paimon data type visitor. [82 implementers]
paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/JdbcToPaimonTypeVisitor.java
DatasetConfigFacet (Interface)
Builtin config facet for dataset. Stub for Flink 1.x compatibility. [9 implementers]
paimon-flink/paimon-flink1-common/src/main/java/org/apache/flink/streaming/api/lineage/DatasetConfigFacet.java
TableBulkLoader (Interface)
Bulk loader for the table. [11 implementers]
paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/lookup/FullCacheLookupTable.java
WriteableObjectInspector (Interface)
Interface for convert the hive primitive type to paimon dataType. [35 implementers]
paimon-hive/paimon-hive-connector-common/src/main/java/org/apache/paimon/hive/objectinspector/WriteableObjectInspector.java
HiveMetastoreProxySupplier (Interface)
Function interface for creating hive metastore proxy. [72 implementers]
paimon-hive/paimon-hive-catalog/src/main/java/org/apache/paimon/hive/RetryingMetaStoreClientFactory.java
Procedure (Interface)
An interface that defines an executable stored procedure. [37 implementers]
paimon-spark/paimon-spark-common/src/main/java/org/apache/paimon/spark/procedure/Procedure.java

Core symbols most depended-on inside this repo

sql
called by 3192
paimon-api/src/main/java/org/apache/paimon/function/FunctionDefinition.java
of
called by 2505
paimon-common/src/main/java/org/apache/paimon/data/GenericRow.java
key
called by 2302
paimon-common/src/main/java/org/apache/paimon/fileindex/rangebitmap/dictionary/chunked/Chunk.java
get
called by 2293
paimon-flink/paimon-flink-common/src/main/java/org/apache/paimon/flink/lookup/LookupTable.java
add
called by 2069
paimon-core/src/main/java/org/apache/paimon/lookup/SetState.java
INT
called by 2032
paimon-api/src/main/java/org/apache/paimon/types/DataTypes.java
of
called by 2019
paimon-flink/paimon-flink1-common/src/main/java/org/apache/flink/types/variant/VariantBuilder.java
fromString
called by 1937
paimon-common/src/main/java/org/apache/paimon/data/BinaryString.java

Shape

Method 35,749
Class 5,273
Function 804
Interface 505
Enum 123
Route 28

Languages

Java87%
Python9%
TypeScript3%

Modules by API surface

docs/static/js/redoc.standalone.js1,325 symbols
paimon-api/src/main/java/org/apache/paimon/CoreOptions.java352 symbols
paimon-filesystems/paimon-s3-impl/src/main/java/com/amazonaws/services/s3/model/transform/XmlResponsesSaxParser.java180 symbols
paimon-core/src/main/java/org/apache/paimon/catalog/Catalog.java153 symbols
paimon-format/src/main/java/org/apache/orc/OrcFile.java129 symbols
paimon-core/src/main/java/org/apache/paimon/table/system/AuditLogTable.java109 symbols
paimon-core/src/test/java/org/apache/paimon/rest/RESTCatalogTest.java100 symbols
paimon-format/src/main/java/org/apache/paimon/format/parquet/reader/ParquetVectorUpdaterFactory.java95 symbols
paimon-api/src/main/java/org/apache/paimon/schema/SchemaChange.java95 symbols
paimon-format/src/main/java/org/apache/paimon/format/avro/FieldReaderFactory.java90 symbols
paimon-common/src/main/java/org/apache/paimon/fileindex/rangebitmap/dictionary/chunked/KeyFactory.java86 symbols
paimon-core/src/test/java/org/apache/paimon/rest/RESTCatalogServer.java84 symbols

Datastores touched

(mysql)Database · 1 repos
defaultDatabase · 1 repos
metastoreDatabase · 1 repos
(mongodb)Database · 1 repos
blob_demoDatabase · 1 repos
cascade_dbDatabase · 1 repos
db2Database · 1 repos
drop_dbDatabase · 1 repos

For agents

$ claude mcp add paimon \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact