File: doc.go

package info (click to toggle)
golang-github-tideland-golib 4.24.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,144 kB
  • sloc: makefile: 4
file content (33 lines) | stat: -rw-r--r-- 1,607 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Tideland Go Library - Redis Client
//
// Copyright (C) 2009-2017 Frank Mueller / Oldenburg / Germany
//
// All rights reserved. Use of this source code is governed
// by the new BSD license.

// Package redis of the Tideland Go Library provides a very powerful as well
// as convenient client for the Redis database.
//
// After opening the database with Open() a pooled connection can be
// retrieved using db.Connection(). It has be returnded to the pool with
// with conn.Return(), optimally done using a defer after retrieving. The
// connection provides a conn.Do() method to execute any command. It returns
// a result set with helpers to access the returned values and convert
// them into Go types. For typical returnings there are conn.DoXxx() methods.
//
// All conn.Do() methods work atomically and are able to run all commands
// except subscriptions. Also the execution of scripts is possible that
// way. Additionally the execution of commands can be pipelined. The
// pipeline can be retrieved db.Pipeline(). It provides a ppl.Do()
// method for the execution of individual commands. Their results can
// be collected with ppl.Collect(), which returns a sice of result sets
// containing the responses of the commands.
//
// Due to the nature of the subscription the client provides an own
// type which can be retrieved with db.Subscription(). Here channels,
// in the sense of the Redis Pub/Sub, can be subscribed or unsubscribed.
// Published values can be retrieved with sub.Pop(). If the subscription
// is not needed anymore it can be closed using sub.Close().
package redis

// EOF