zishuo/nats.go
1
0
Fork 0
mirror of https://github.com/nats-io/nats.go.git synced 2025-09-26 20:41:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move new JetStream API docs to top level README (#1352)

Browse Source
This commit is contained in:
Piotr Piotrowski
2023-07-20 11:56:34 +02:00
committed by GitHub
parent 83e1310914
commit 4354bd988a
2 changed files with 110 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@@ -90,91 +90,47 @@ nc.Drain()
nc.Close() nc.Close()
``` ```
## JetStream Basic Usage ## JetStream
> __NOTE__ JetStream is the built-in NATS persistence system. `nats.go` provides a built-in
> API enabling both managing JetStream assets as well as publishing/consuming
> We encourage you to try out a new, simplified version on JetStream API. persistent messages.
> The new API is currently in preview and is available under `jetstream` package.
> ### Basic usage
> You can find more information on the new API [here](https://github.com/nats-io/nats.go/blob/main/jetstream/README.md)
```go ```go
import "github.com/nats-io/nats.go" // connect to nats server
// Connect to NATS
nc, _ := nats.Connect(nats.DefaultURL) nc, _ := nats.Connect(nats.DefaultURL)
// Create JetStream Context // create jetstream context from nats connection
js, _ := nc.JetStream(nats.PublishAsyncMaxPending(256)) js, _ := jetstream.New(nc)
// Simple Stream Publisher ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
js.Publish("ORDERS.scratch", []byte("hello")) defer cancel()
// Simple Async Stream Publisher // get existing stream handle
for i := 0; i < 500; i++ { stream, _ := js.Stream(ctx, "foo")
js.PublishAsync("ORDERS.scratch", []byte("hello"))
}
select {
case <-js.PublishAsyncComplete():
case <-time.After(5 * time.Second):
fmt.Println("Did not resolve in time")
}
// Simple Async Ephemeral Consumer // retrieve consumer handle from a stream
js.Subscribe("ORDERS.*", func(m *nats.Msg) { cons, _ := stream.Consumer(ctx, "cons")
fmt.Printf("Received a JetStream message: %s\n", string(m.Data))
// consume messages from the consumer in callback
cc, _ := cons.Consume(func(msg jetstream.Msg) {
fmt.Println("Received jetstream message: ", string(msg.Data()))
msg.Ack()
}) })
defer cc.Stop()
// Simple Sync Durable Consumer (optional SubOpts at the end)
sub, err := js.SubscribeSync("ORDERS.*", nats.Durable("MONITOR"), nats.MaxDeliver(3))
m, err := sub.NextMsg(timeout)
// Simple Pull Consumer
sub, err := js.PullSubscribe("ORDERS.*", "MONITOR")
msgs, err := sub.Fetch(10)
// Unsubscribe
sub.Unsubscribe()
// Drain
sub.Drain()
``` ```
## JetStream Basic Management To find more information on `nats.go` JetStream API, visit
[`jetstream/README.md`](jetstream/README.md)
```go > The current JetStream API replaces the [legacy JetStream API](legacy_jetstream.md)
import "github.com/nats-io/nats.go"
// Connect to NATS ## Service API
nc, _ := nats.Connect(nats.DefaultURL)
// Create JetStream Context The service API (`micro`) allows you to [easily build NATS services](micro/README.md) The
js, _ := nc.JetStream() services API is currently in beta release.
// Create a Stream
js.AddStream(&nats.StreamConfig{
Name: "ORDERS",
Subjects: []string{"ORDERS.*"},
})
// Update a Stream
js.UpdateStream(&nats.StreamConfig{
Name: "ORDERS",
MaxBytes: 8,
})
// Create a Consumer
js.AddConsumer("ORDERS", &nats.ConsumerConfig{
Durable: "MONITOR",
})
// Delete Consumer
js.DeleteConsumer("ORDERS", "MONITOR")
// Delete Stream
js.DeleteStream("ORDERS")
```
## Encoded Connections ## Encoded Connections

83
legacy_jetstream.md Normal file
View File

@@ -0,0 +1,83 @@
# Legacy JetStream API
This is a documentation for the legacy JetStream API. A README for the current
API can be found [here](jetstream/README.md)
## JetStream Basic Usage
```go
import "github.com/nats-io/nats.go"
// Connect to NATS
nc, _ := nats.Connect(nats.DefaultURL)
// Create JetStream Context
js, _ := nc.JetStream(nats.PublishAsyncMaxPending(256))
// Simple Stream Publisher
js.Publish("ORDERS.scratch", []byte("hello"))
// Simple Async Stream Publisher
for i := 0; i < 500; i++ {
js.PublishAsync("ORDERS.scratch", []byte("hello"))
}
select {
case <-js.PublishAsyncComplete():
case <-time.After(5 * time.Second):
fmt.Println("Did not resolve in time")
}
// Simple Async Ephemeral Consumer
js.Subscribe("ORDERS.*", func(m *nats.Msg) {
fmt.Printf("Received a JetStream message: %s\n", string(m.Data))
})
// Simple Sync Durable Consumer (optional SubOpts at the end)
sub, err := js.SubscribeSync("ORDERS.*", nats.Durable("MONITOR"), nats.MaxDeliver(3))
m, err := sub.NextMsg(timeout)
// Simple Pull Consumer
sub, err := js.PullSubscribe("ORDERS.*", "MONITOR")
msgs, err := sub.Fetch(10)
// Unsubscribe
sub.Unsubscribe()
// Drain
sub.Drain()
```
## JetStream Basic Management
```go
import "github.com/nats-io/nats.go"
// Connect to NATS
nc, _ := nats.Connect(nats.DefaultURL)
// Create JetStream Context
js, _ := nc.JetStream()
// Create a Stream
js.AddStream(&nats.StreamConfig{
Name: "ORDERS",
Subjects: []string{"ORDERS.*"},
})
// Update a Stream
js.UpdateStream(&nats.StreamConfig{
Name: "ORDERS",
MaxBytes: 8,
})
// Create a Consumer
js.AddConsumer("ORDERS", &nats.ConsumerConfig{
Durable: "MONITOR",
})
// Delete Consumer
js.DeleteConsumer("ORDERS", "MONITOR")
// Delete Stream
js.DeleteStream("ORDERS")
```