You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/08/09 08:59:04 UTC
[GitHub] [pulsar] blankensteiner commented on a diff in pull request #17010: [improve][doc] Separate language-specific and language-agnostic clients
blankensteiner commented on code in PR #17010:
URL: https://github.com/apache/pulsar/pull/17010#discussion_r941084726
##########
site2/docs/client-libraries.md:
##########
@@ -4,42 +4,74 @@ title: Pulsar client libraries
sidebar_label: "Overview"
---
-Pulsar supports the following client libraries:
+Pulsar supports the following language specific client libraries:
-| Language | Documentation | Release note | Code repo |
-|-----------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------|-------------------------------------------------------------------------------|
-| Java | - [User doc](client-libraries-java.md) <br/><br/> - [API doc](/api/client/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client) |
-| C++ | - [User doc](client-libraries-cpp.md) <br/><br/> - [API doc](/api/cpp/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp) |
-| Python | - [User doc](client-libraries-python.md) <br/><br/> - [API doc](/api/python/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) |
-| WebSocket | [User doc](client-libraries-websocket.md) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-websocket) |
-| Go client | [User doc](client-libraries-go.md) | [Here](https://github.com/apache/pulsar-client-go/blob/master/CHANGELOG) | [Here](https://github.com/apache/pulsar-client-go) |
-| Node.js | [User doc](client-libraries-node.md) | [Here](https://github.com/apache/pulsar-client-node/releases) | [Here](https://github.com/apache/pulsar-client-node) |
-| C# | [User doc](client-libraries-dotnet.md) | [Here](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG) | [Here](https://github.com/apache/pulsar-dotpulsar) |
+| Language | Documentation | Release note | Code repo |
+| --------- | -------------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
+| Java | [User doc](client-libraries-java.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client) |
+| C++ | [User doc](client-libraries-cpp.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp) |
+| Python | [User doc](client-libraries-python.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) |
+| Go client | [User doc](client-libraries-go.md) | [Standalone](https://github.com/apache/pulsar-client-go/blob/master/CHANGELOG) | [Standalone](https://github.com/apache/pulsar-client-go) |
+| Node.js | [User doc](client-libraries-node.md) | [Standalone](https://github.com/apache/pulsar-client-node/releases) | [Standalone](https://github.com/apache/pulsar-client-node) |
+| C# | [User doc](client-libraries-dotnet.md) | [Standalone](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG) | [Standalone](https://github.com/apache/pulsar-dotpulsar) |
-:::note
+Pulsar supports the following language-agnostic client libraries:
-- The code repos of **Java, C++, Python,** and **WebSocket** clients are hosted in the [Pulsar main repo](https://github.com/apache/pulsar) and these clients are released with Pulsar, so their release notes are parts of [Pulsar release note](/release-notes/).
-- The code repos of **Go, Node.js,** and **C#** clients are hosted outside of the [Pulsar main repo](https://github.com/apache/pulsar) and these clients are not released with Pulsar, so they have independent release notes.
-
-:::
+| Interface | Documentation | Release note | Code repo |
+| --------- | ----------------------------------------- | -------------------------- | ------------------------------------------------------------------------ |
+| REST | [User doc](client-libraries-rest.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-broker) |
+| WebSocket | [User doc](client-libraries-websocket.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-websocket) |
## Feature matrix
+
Pulsar client feature matrix for different languages is listed on [Pulsar Feature Matrix (Client and Function)](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=1784579914) page.
## Third-party clients
Besides the official released clients, multiple projects on developing Pulsar clients are available in different languages.
-> If you have developed a new Pulsar client, feel free to submit a pull request and add your client to the list below.
-
-| Language | Project | Maintainer | License | Description |
-|----------|---------|------------|---------|-------------|
-| Go | [pulsar-client-go](https://github.com/Comcast/pulsar-client-go) | [Comcast](https://github.com/Comcast) | [](https://opensource.org/licenses/Apache-2.0) | A native golang client |
-| Go | [go-pulsar](https://github.com/t2y/go-pulsar) | [t2y](https://github.com/t2y) | [](https://opensource.org/licenses/Apache-2.0) |
-| Haskell | [supernova](https://github.com/cr-org/supernova) | [Chatroulette](https://github.com/cr-org) | [](https://opensource.org/licenses/Apache-2.0) | Native Pulsar client for Haskell |
-| Scala | [neutron](https://github.com/cr-org/neutron) | [Chatroulette](https://github.com/cr-org) | [](https://opensource.org/licenses/Apache-2.0) | Purely functional Apache Pulsar client for Scala built on top of Fs2 |
-| Scala | [pulsar4s](https://github.com/sksamuel/pulsar4s) | [sksamuel](https://github.com/sksamuel) | [](https://opensource.org/licenses/Apache-2.0) | Idomatic, typesafe, and reactive Scala client for Apache Pulsar |
-| Rust | [pulsar-rs](https://github.com/wyyerd/pulsar-rs) | [Wyyerd Group](https://github.com/wyyerd) | [](https://opensource.org/licenses/Apache-2.0) | Future-based Rust bindings for Apache Pulsar |
-| .NET | [pulsar-client-dotnet](https://github.com/fsharplang-ru/pulsar-client-dotnet) | [Lanayx](https://github.com/Lanayx) | [](https://opensource.org/licenses/MIT) | Native .NET client for C#/F#/VB |
-| Node.js | [pulsar-flex](https://github.com/ayeo-flex-org/pulsar-flex) | [Daniel Sinai](https://github.com/danielsinai), [Ron Farkash](https://github.com/ronfarkash), [Gal Rosenberg](https://github.com/galrose)| [](https://opensource.org/licenses/MIT) | Native Nodejs client |
-| PHP | [pulsar-client-php](https://github.com/ikilobyte/pulsar-client-php) | [ikilobyte](https://github.com/ikilobyte) | [](https://opensource.org/licenses/MIT) | Native PHP client |
+> Want your repository listed here? Just submit a PR to the [pulsar repository](https://github.com/apache/pulsar/edit/master/site2/docs/client-libraries.md).
+
+### C#
Review Comment:
Hi @tisonkun - it would make sense to list C# (DotPulsar) and F# as separate languages even though they share the .NET runtime.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org