Tree @watch-fixes/main (Download .tar.gz)
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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | # lua-resty-redis-connector Connection utilities for [lua-resty-redis](https://github.com/openresty/lua-resty-redis), making it easy and reliable to connect to Redis hosts, either directly or via [Redis Sentinel](http://redis.io/topics/sentinel). ## Synopsis Quick and simple authenticated connection on localhost to DB 2: ```lua local redis, err = require("resty.redis.connector").new({ url = "redis://PASSWORD@127.0.0.1:6379/2", }):connect() ``` More verbose configuration, with timeouts and a default password: ```lua local rc = require("resty.redis.connector").new({ connect_timeout = 50, read_timeout = 5000, keepalive_timeout = 30000, password = "mypass", }) local redis, err = rc:connect({ url = "redis://127.0.0.1:6379/2", }) -- ... local ok, err = rc:set_keepalive(redis) -- uses keepalive params ``` Keep all config in a table, to easily create / close connections as needed: ```lua local rc = require("resty.redis.connector").new({ connect_timeout = 50, read_timeout = 5000, keepalive_timeout = 30000, host = "127.0.0.1", port = 6379, db = 2, password = "mypass", }) local redis, err = rc:connect() -- ... local ok, err = rc:set_keepalive(redis) ``` [connect](#connect) can be used to override some defaults given in [new](#new), which are pertinent to this connection only. ```lua local rc = require("resty.redis.connector").new({ host = "127.0.0.1", port = 6379, db = 2, }) local redis, err = rc:connect({ db = 5, }) ``` ## DSN format If the `params.url` field is present then it will be parsed to set the other params. Any manually specified params will override values given in the DSN. *Note: this is a behaviour change as of v0.06. Previously, the DSN values would take precedence.* ### Direct Redis connections The format for connecting directly to Redis is: `redis://PASSWORD@HOST:PORT/DB` The `PASSWORD` and `DB` fields are optional, all other components are required. ### Connections via Redis Sentinel When connecting via Redis Sentinel, the format is as follows: `sentinel://PASSWORD@MASTER_NAME:ROLE/DB` Again, `PASSWORD` and `DB` are optional. `ROLE` must be either `m` or `s` for master / slave respectively. A table of `sentinels` must also be supplied. e.g. ```lua local redis, err = rc:connect{ url = "sentinel://mymaster:a/2", sentinels = { { host = "127.0.0.1", port = 26379" }, } } ``` ## Proxy Mode Enable the `connection_is_proxied` parameter if connecting to Redis through a proxy service (e.g. Twemproxy). These proxies generally only support a limited sub-set of Redis commands, those which do not require state and do not affect multiple keys. Databases and transactions are also not supported. Proxy mode will disable switching to a DB on connect. Unsupported commands (defaults to those not supported by Twemproxy) will return `nil, err` immediately rather than being sent to the proxy, which can result in dropped connections. `discard` will not be sent when adding connections to the keepalive pool ## Disabled commands If configured as a table of commands, the command methods will be replaced by a function which immediately returns `nil, err` without forwarding the command to the server ## Default Parameters ```lua { connect_timeout = 100, read_timeout = 1000, connection_options = {}, -- pool, etc keepalive_timeout = 60000, keepalive_poolsize = 30, host = "127.0.0.1", port = "6379", path = "", -- unix socket path, e.g. /tmp/redis.sock password = "", db = 0, master_name = "mymaster", role = "master", -- master | slave sentinels = {}, connection_is_proxied = false, disabled_commands = {}, } ``` ## API * [new](#new) * [connect](#connect) * [set_keepalive](#set_keepalive) * [Utilities](#utilities) * [connect_via_sentinel](#connect_via_sentinel) * [try_hosts](#try_hosts) * [connect_to_host](#connect_to_host) * [sentinel.get_master](#sentinelget_master) * [sentinel.get_slaves](#sentinelget_slaves) ### new `syntax: rc = redis_connector.new(params)` Creates the Redis Connector object, overring default params with the ones given. In case of failures, returns `nil` and a string describing the error. ### connect `syntax: redis, err = rc:connect(params)` Attempts to create a connection, according to the [params](#parameters) supplied, falling back to defaults given in `new` or the predefined defaults. If a connection cannot be made, returns `nil` and a string describing the reason. Note that `params` given here do not change the connector's own configuration, and are only used to alter this particular connection operation. As such, the following parameters have no meaning when given in `connect`. * `keepalive_poolsize` * `keepalive_timeout` * `connection_is_proxied` * `disabled_commands` ### set_keepalive `syntax: ok, err = rc:set_keepalive(redis)` Attempts to place the given Redis connection on the keepalive pool, according to timeout and poolsize params given in `new` or the predefined defaults. This allows an application to release resources without having to keep track of application wide keepalive settings. Returns `1` or in the case of error, `nil` and a string describing the error. ## Utilities The following methods are not typically needed, but may be useful if a custom interface is required. ### connect_via_sentinel `syntax: redis, err = rc:connect_via_sentinel(params)` Returns a Redis connection by first accessing a sentinel as supplied by the `params.sentinels` table, and querying this with the `params.master_name` and `params.role`. ### try_hosts `syntax: redis, err = rc:try_hosts(hosts)` Tries the hosts supplied in order and returns the first successful connection. ### connect_to_host `syntax: redis, err = rc:connect_to_host(host)` Attempts to connect to the supplied `host`. ### sentinel.get_master `syntax: master, err = sentinel.get_master(sentinel, master_name)` Given a connected Sentinel instance and a master name, will return the current master Redis instance. ### sentinel.get_slaves `syntax: slaves, err = sentinel.get_slaves(sentinel, master_name)` Given a connected Sentinel instance and a master name, will return a list of registered slave Redis instances. # Author James Hurst <james@pintsized.co.uk> # Licence This module is licensed under the 2-clause BSD license. Copyright (c) James Hurst <james@pintsized.co.uk> All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Commit History @watch-fixes/main
0
»»
- Update upstream source from tag 'upstream/0.06' ChangZhuo Chen (陳昌倬) 6 years ago
- New upstream version 0.06 ChangZhuo Chen (陳昌倬) 6 years ago
- Update changelog ChangZhuo Chen (陳昌倬) 6 years ago
- New upstream version 0.04 ChangZhuo Chen (陳昌倬) 6 years ago
- Updated version 0.04 from 'upstream/0.04' ChangZhuo Chen (陳昌倬) 6 years ago
- Update gbp.conf ChangZhuo Chen (陳昌倬) 6 years ago
- Bump Standards-Version to 4.0.0 ChangZhuo Chen (陳昌倬) 6 years ago
- Bump compat to 10 ChangZhuo Chen (陳昌倬) 6 years ago
- Update Vcs-* fields ChangZhuo Chen (陳昌倬) 6 years ago
- Update changelog ChangZhuo Chen (陳昌倬) 8 years ago
- Merge tag 'upstream/0.03' into debian/sid ChangZhuo Chen (陳昌倬) 8 years ago
- Imported Upstream version 0.03 ChangZhuo Chen (陳昌倬) 8 years ago
- Update Depends ChangZhuo Chen (陳昌倬) 8 years ago
- Update changelog ChangZhuo Chen (陳昌倬) 8 years ago
- Fix package name ChangZhuo Chen (陳昌倬) 8 years ago
- Fix dh_auto_clean ChangZhuo Chen (陳昌倬) 8 years ago
- Debianize ChangZhuo Chen (陳昌倬) 8 years ago
- Imported Upstream version 0.02 ChangZhuo Chen (陳昌倬) 8 years ago
0
»»