इस ट्यूटोरियल में, आप सीखेंगे कि रेडिस के साथ पायथन का उपयोग कैसे करें (उच्चारण लाल-जारी, या शायद आरईई-डिस या रेड-डीईईएस, जो आप पूछते हैं उसके आधार पर), जो कि एक लाइटनिंग फास्ट इन-मेमोरी की-वैल्यू स्टोर है। A से Z तक किसी भी चीज़ के लिए उपयोग किया जा सकता है। यहाँ सात सप्ताह में सात डेटाबेस है , डेटाबेस पर एक लोकप्रिय पुस्तक, Redis के बारे में कहना है:
<ब्लॉकक्वॉट>इसका उपयोग करना आसान नहीं है; यह एक खुशी है। अगर प्रोग्रामर के लिए एपीआई यूएक्स है, तो रेडिस मैक क्यूब के साथ म्यूजियम ऑफ मॉडर्न आर्ट में होना चाहिए।
…
और जब गति की बात आती है, तो रेडिस को हराना मुश्किल होता है। पढ़ना तेज़ है, और लिखना और भी तेज़ है, 100,000 से ऊपर SET
. को संभालना कुछ बेंचमार्क द्वारा प्रति सेकंड संचालन। (स्रोत)
जिज्ञासु? यह ट्यूटोरियल पायथन प्रोग्रामर के लिए बनाया गया है, जिनके पास शून्य से थोड़ा रेडिस अनुभव हो सकता है। हम एक साथ दो टूल से निपटेंगे और रेडिस के साथ-साथ इसके पायथन क्लाइंट लाइब्रेरी में से एक, redis-py
दोनों को पेश करेंगे। ।
redis-py
(जिसे आप केवल redis
. के रूप में आयात करते हैं ) रेडिस के लिए कई पायथन ग्राहकों में से एक है, लेकिन इसे रेडिस डेवलपर्स द्वारा "वर्तमान में पायथन के लिए जाने का तरीका" के रूप में बिल किए जाने का गौरव प्राप्त है। यह आपको पाइथन से रेडिस कमांड को कॉल करने देता है, और बदले में परिचित पायथन ऑब्जेक्ट वापस प्राप्त करता है।
इस ट्यूटोरियल में, आप कवर करेंगे :
- Redis को स्रोत से स्थापित करना और परिणामी बायनेरिज़ के उद्देश्य को समझना
- रेडिस के बाइट-साइज़ स्लाइस को सीखना, जिसमें सिंटैक्स, प्रोटोकॉल और डिज़ाइन शामिल है
- मास्टरिंग
redis-py
रेडिस के प्रोटोकॉल को कैसे लागू करता है, इसकी झलक भी देखते हुए - Amazon ElastiCache Redis सर्वर इंस्टेंस के साथ सेट अप और संचार करना
निःशुल्क डाउनलोड: पायथन ट्रिक्स से एक नमूना अध्याय प्राप्त करें:वह पुस्तक जो आपको सरल उदाहरणों के साथ पायथन की सर्वोत्तम प्रथाओं को दिखाती है जिसे आप और अधिक सुंदर + पाइथोनिक कोड लिखने के लिए तुरंत लागू कर सकते हैं।
स्रोत से Redis इंस्टॉल करना
जैसा कि मेरे परदादा ने कहा, स्रोत से स्थापित करने जैसा कुछ भी धैर्य नहीं बनाता है। यह खंड आपको रेडिस को डाउनलोड करने, बनाने और स्थापित करने के बारे में बताएगा। मैं वादा करता हूँ कि इससे थोड़ा भी नुकसान नहीं होगा!
नोट :यह खंड मैक ओएस एक्स या लिनक्स पर स्थापना की ओर उन्मुख है। यदि आप Windows का उपयोग कर रहे हैं, तो Redis का एक Microsoft कांटा है जिसे Windows सेवा के रूप में स्थापित किया जा सकता है। यह कहने के लिए पर्याप्त है कि एक प्रोग्राम के रूप में रेडिस एक लिनक्स बॉक्स पर सबसे अधिक आराम से रहता है और विंडोज़ पर यह सेटअप और उपयोग बारीक हो सकता है।
सबसे पहले, रेडिस स्रोत कोड को टारबॉल के रूप में डाउनलोड करें:
$ redisurl="http://download.redis.io/redis-stable.tar.gz"
$ curl -s -o redis-stable.tar.gz $redisurl
इसके बाद, root
पर स्विच करें और संग्रह के स्रोत कोड को /usr/local/lib/
. पर निकालें :
$ sudo su root
$ mkdir -p /usr/local/lib/
$ chmod a+w /usr/local/lib/
$ tar -C /usr/local/lib/ -xzf redis-stable.tar.gz
वैकल्पिक रूप से, अब आप संग्रह को स्वयं हटा सकते हैं:
$ rm redis-stable.tar.gz
यह आपको /usr/local/lib/redis-stable/
पर एक स्रोत कोड भंडार के साथ छोड़ देगा . Redis C में लिखा गया है, इसलिए आपको make
के साथ कंपाइल, लिंक और इंस्टाल करना होगा। उपयोगिता:
$ cd /usr/local/lib/redis-stable/
$ make && make install
make install
. का उपयोग करना दो कार्य करता है:
-
पहला
make
कमांड सोर्स कोड को कंपाइल और लिंक करता है। -
make install
भाग बायनेरिज़ लेता है और उन्हें/usr/local/bin/
. पर कॉपी करता है ताकि आप उन्हें कहीं से भी चला सकें (यह मानते हुए कि/usr/local/bin/
PATH
में है )।
यहां अब तक के सभी चरण दिए गए हैं:
$ redisurl="http://download.redis.io/redis-stable.tar.gz"
$ curl -s -o redis-stable.tar.gz $redisurl
$ sudo su root
$ mkdir -p /usr/local/lib/
$ chmod a+w /usr/local/lib/
$ tar -C /usr/local/lib/ -xzf redis-stable.tar.gz
$ rm redis-stable.tar.gz
$ cd /usr/local/lib/redis-stable/
$ make && make install
इस समय, यह पुष्टि करने के लिए कुछ समय दें कि Redis आपके PATH
में है और इसके संस्करण की जाँच करें:
$ redis-cli --version
redis-cli 5.0.3
अगर आपके शेल को redis-cli
नहीं मिल रहा है , यह सुनिश्चित करने के लिए जांचें कि /usr/local/bin/
आपके PATH
. पर है पर्यावरण चर, और यदि नहीं तो इसे जोड़ें।
redis-cli
. के अलावा , make install
वास्तव में मुट्ठी भर विभिन्न निष्पादन योग्य फाइलों (और एक सिमलिंक) को /usr/local/bin/
पर रखा जाता है :
$ # A snapshot of executables that come bundled with Redis
$ ls -hFG /usr/local/bin/redis-* | sort
/usr/local/bin/redis-benchmark*
/usr/local/bin/redis-check-aof*
/usr/local/bin/redis-check-rdb*
/usr/local/bin/redis-cli*
/usr/local/bin/redis-sentinel@
/usr/local/bin/redis-server*
हालांकि इन सभी का कुछ-न-कुछ उपयोग है, लेकिन जिन दो का आप शायद सबसे अधिक ध्यान रखेंगे वे हैं redis-cli
और redis-server
, जिसे हम शीघ्र ही रेखांकित करेंगे। लेकिन इससे पहले कि हम उस तक पहुंचें, कुछ आधारभूत कॉन्फ़िगरेशन सेट करना क्रम में है।
Redis को कॉन्फ़िगर करना
रेडिस अत्यधिक विन्यास योग्य है। हालांकि यह बॉक्स से बाहर ठीक चलता है, आइए कुछ नंगे-हड्डियों के कॉन्फ़िगरेशन विकल्पों को सेट करने के लिए एक मिनट का समय दें जो डेटाबेस दृढ़ता और बुनियादी सुरक्षा से संबंधित हैं:
$ sudo su root
$ mkdir -p /etc/redis/
$ touch /etc/redis/6379.conf
अब, निम्नलिखित को /etc/redis/6379.conf
पर लिखें . हम पूरे ट्यूटोरियल में धीरे-धीरे इनमें से अधिकांश का मतलब कवर करेंगे:
# /etc/redis/6379.conf
port 6379
daemonize yes
save 60 1
bind 127.0.0.1
tcp-keepalive 300
dbfilename dump.rdb
dir ./
rdbcompression yes
Redis कॉन्फ़िगरेशन स्व-दस्तावेजीकरण है, नमूने के साथ redis.conf
आपके पढ़ने के आनंद के लिए रेडिस स्रोत में स्थित फ़ाइल। यदि आप उत्पादन प्रणाली में रेडिस का उपयोग कर रहे हैं, तो यह सभी विकर्षणों को रोकने के लिए भुगतान करता है और इस नमूना फ़ाइल को पूरी तरह से पढ़ने के लिए समय लेता है ताकि खुद को रेडिस के इन और आउट से परिचित कराया जा सके और अपने सेटअप को ठीक किया जा सके।
रेडिस के दस्तावेज़ीकरण के कुछ हिस्सों सहित कुछ ट्यूटोरियल, शेल स्क्रिप्ट को चलाने का सुझाव भी दे सकते हैं install_server.sh
redis/utils/install_server.sh
. में स्थित है . उपरोक्त के अधिक व्यापक विकल्प के रूप में इसे चलाने के लिए आपका हर तरह से स्वागत है, लेकिन install_server.sh
के बारे में कुछ बारीक बिंदुओं पर ध्यान दें :
- यह Mac OS X—केवल डेबियन और उबंटू लिनक्स पर काम नहीं करेगा।
- यह कॉन्फ़िगरेशन विकल्पों के एक पूर्ण सेट को
/etc/redis/6379.conf
में इंजेक्ट करेगा । - यह एक सिस्टम V
init
लिखेगा स्क्रिप्ट से/etc/init.d/redis_6379
जो आपकोsudo service redis_6379 start
. करने देगा ।
Redis क्विकस्टार्ट गाइड में अधिक उचित Redis सेटअप पर एक अनुभाग भी शामिल है, लेकिन ऊपर दिए गए कॉन्फ़िगरेशन विकल्प इस ट्यूटोरियल और आरंभ करने के लिए पूरी तरह से पर्याप्त होने चाहिए।
सुरक्षा नोट: कुछ साल पहले, यदि कोई कॉन्फ़िगरेशन सेट नहीं किया गया था, तो रेडिस के लेखक ने रेडिस के पुराने संस्करणों में सुरक्षा कमजोरियों की ओर इशारा किया। Redis 3.2 (वर्तमान संस्करण 5.0.3 मार्च 2019 तक) ने इस घुसपैठ को रोकने के लिए कदम उठाए, protected-mode
सेट किया। yes
. का विकल्प डिफ़ॉल्ट रूप से।
हम स्पष्ट रूप से bind 127.0.0.1
. सेट करते हैं रेडिस को केवल लोकलहोस्ट इंटरफ़ेस से कनेक्शन सुनने के लिए, हालांकि आपको इस श्वेतसूची को वास्तविक उत्पादन सर्वर में विस्तारित करने की आवश्यकता होगी। protected-mode
का बिंदु एक सुरक्षा के रूप में है जो इस बाइंड-टू-लोकलहोस्ट व्यवहार की नकल करेगा यदि आप अन्यथा bind
के तहत कुछ भी निर्दिष्ट नहीं करते हैं विकल्प।
उस वर्ग दूर के साथ, अब हम खुद रेडिस का उपयोग कर सकते हैं।
Redis के लिए दस या इतने ही मिनट
यह खंड आपको खतरनाक होने के लिए रेडिस के बारे में पर्याप्त ज्ञान प्रदान करेगा, इसके डिजाइन और बुनियादी उपयोग को रेखांकित करेगा।
आरंभ करना
Redis में क्लाइंट-सर्वर आर्किटेक्चर है और अनुरोध-प्रतिक्रिया मॉडल . का उपयोग करता है . इसका मतलब है कि आप (क्लाइंट) डिफ़ॉल्ट रूप से पोर्ट 6379 पर टीसीपी कनेक्शन के माध्यम से एक रेडिस सर्वर से जुड़ते हैं। आप कुछ कार्रवाई का अनुरोध करते हैं (जैसे पढ़ने, लिखने, प्राप्त करने, सेटिंग करने या अपडेट करने का कोई तरीका), और सर्वर सेवा करता है आप एक प्रतिक्रिया वापस करते हैं।
एक ही सर्वर से बात करने वाले कई क्लाइंट हो सकते हैं, जो वास्तव में रेडिस या कोई क्लाइंट-सर्वर एप्लिकेशन है। प्रत्येक क्लाइंट सर्वर प्रतिक्रिया की प्रतीक्षा कर रहे सॉकेट पर एक (आमतौर पर अवरुद्ध) पढ़ता है।
cli
redis-cli
में कमांड लाइन इंटरफ़ेस . के लिए खड़ा है , और server
redis-server
में सर्वर चलाने के लिए है। ठीक उसी तरह जैसे आप python
चलाते हैं कमांड लाइन पर, आप redis-cli
चला सकते हैं एक इंटरैक्टिव आरईपीएल (रीड इवल प्रिंट लूप) में कूदने के लिए जहां आप सीधे शेल से क्लाइंट कमांड चला सकते हैं।
हालांकि, सबसे पहले, आपको redis-server
. लॉन्च करना होगा ताकि आपके पास बात करने के लिए एक रनिंग रेडिस सर्वर हो। विकास में ऐसा करने का एक सामान्य तरीका लोकलहोस्ट पर एक सर्वर शुरू करना है (आईपीवी 4 पता 127.0.0.1
), जो कि डिफ़ॉल्ट है जब तक कि आप रेडिस को अन्यथा न बताएं। आप redis-server
. भी पास कर सकते हैं आपकी कॉन्फ़िगरेशन फ़ाइल का नाम, जो इसके सभी कुंजी-मान युग्मों को कमांड-लाइन तर्कों के रूप में निर्दिष्ट करने के समान है:
$ redis-server /etc/redis/6379.conf
31829:C 07 Mar 2019 08:45:04.030 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
31829:C 07 Mar 2019 08:45:04.030 # Redis version=5.0.3, bits=64, commit=00000000, modified=0, pid=31829, just started
31829:C 07 Mar 2019 08:45:04.030 # Configuration loaded
हमने daemonize
. सेट किया है कॉन्फ़िगरेशन विकल्प yes
, इसलिए सर्वर पृष्ठभूमि में चलता है। (अन्यथा, --daemonize yes
redis-server
. के विकल्प के रूप में ।)
अब आप रेडिस आरईपीएल लॉन्च करने के लिए तैयार हैं। redis-cli
दर्ज करें आपकी कमांड लाइन पर। आपको सर्वर का होस्ट:पोर्ट . दिखाई देगा जोड़ी के बाद >
संकेत:
127.0.0.1:6379>
यहाँ सबसे सरल रेडिस कमांड में से एक है, PING
, जो सिर्फ सर्वर से कनेक्टिविटी का परीक्षण करता है और "PONG"
. देता है अगर चीजें ठीक हैं:
127.0.0.1:6379> PING
PONG
रेडिस कमांड केस-असंवेदनशील हैं, हालांकि उनके पायथन समकक्ष निश्चित रूप से नहीं हैं।
नोट: एक अन्य विवेक जांच के रूप में, आप pgrep
के साथ Redis सर्वर की प्रक्रिया आईडी खोज सकते हैं :
$ pgrep redis-server
26983
सर्वर को मारने के लिए, pkill redis-server
का उपयोग करें कमांड लाइन से। Mac OS X पर, आप redis-cli shutdown
. का भी उपयोग कर सकते हैं ।
इसके बाद, हम कुछ सामान्य रेडिस कमांड का उपयोग करेंगे और उनकी तुलना शुद्ध पायथन में दिखने वाले से करेंगे।
पायथन डिक्शनरी के रूप में रेडिस
रेडिस का अर्थ है रिमोट डिक्शनरी सर्विस ।
"आपका मतलब है, एक पायथन डिक्शनरी की तरह?" आप पूछ सकते हैं।
हां। मोटे तौर पर, आप पायथन डिक्शनरी (या जेनेरिक हैश टेबल) और रेडिस क्या है और क्या करता है, के बीच कई समानताएं बना सकते हैं:
-
एक रेडिस डेटाबेस में कुंजी:मान होता है जोड़े और कमांड जैसे
GET
. का समर्थन करता है ,SET
, औरDEL
, साथ ही कई सौ अतिरिक्त आदेश। -
रेडिस कुंजी हमेशा तार होते हैं।
-
रेडिस मान कई अलग-अलग डेटा प्रकार हो सकते हैं। हम इस ट्यूटोरियल में कुछ अधिक आवश्यक मूल्य डेटा प्रकारों को शामिल करेंगे:
string
,list
,hashes
, औरSET
. कुछ उन्नत प्रकारों में भू-स्थानिक आइटम और नए स्ट्रीम प्रकार शामिल हैं। -
कई रेडिस कमांड निरंतर O(1) समय में काम करते हैं, ठीक उसी तरह जैसे किसी पायथन
dict
से कोई मान प्राप्त करना या कोई हैश टेबल।
रेडिस निर्माता सल्वाटोर सैनफिलिपो शायद रेडिस डेटाबेस की तुलना सादे-वेनिला पायथन से करना पसंद नहीं करेगा dict
. वह प्रोजेक्ट को "डेटा स्ट्रक्चर सर्वर" कहते हैं (की-वैल्यू स्टोर के बजाय, जैसे कि मेमकैच्ड), क्योंकि इसके श्रेय के लिए, रेडिस अतिरिक्त प्रकार के की:वैल्यू को स्टोर करने का समर्थन करता है। स्ट्रिंग:स्ट्रिंग . के अलावा डेटा प्रकार . लेकिन यहां हमारे उद्देश्यों के लिए, यदि आप पायथन की डिक्शनरी ऑब्जेक्ट से परिचित हैं तो यह एक उपयोगी तुलना है।
आइए कूदें और उदाहरण के द्वारा सीखें। हमारा पहला खिलौना डेटाबेस (आईडी 0 के साथ) देश:राजधानी शहर . का मानचित्रण होगा , जहां हम SET
. का उपयोग करते हैं की-वैल्यू पेयर सेट करने के लिए:
127.0.0.1:6379> SET Bahamas Nassau
OK
127.0.0.1:6379> SET Croatia Zagreb
OK
127.0.0.1:6379> GET Croatia
"Zagreb"
127.0.0.1:6379> GET Japan
(nil)
शुद्ध पायथन में बयानों का संबंधित क्रम इस तरह दिखेगा:
>>>>>> capitals = {}
>>> capitals["Bahamas"] = "Nassau"
>>> capitals["Croatia"] = "Zagreb"
>>> capitals.get("Croatia")
'Zagreb'
>>> capitals.get("Japan") # None
हम capitals.get("Japan")
. का उपयोग करते हैं के बजाय capitals["Japan"]
क्योंकि रेडिस nil
लौटाएगा कुंजी नहीं मिलने पर त्रुटि के बजाय, जो कि पायथन के None
. के समान है ।
Redis आपको एक कमांड MSET
. में कई की-वैल्यू पेयर सेट करने और प्राप्त करने की भी अनुमति देता है और MGET
, क्रमशः:
127.0.0.1:6379> MSET Lebanon Beirut Norway Oslo France Paris
OK
127.0.0.1:6379> MGET Lebanon Norway Bahamas
1) "Beirut"
2) "Oslo"
3) "Nassau"
पायथन में सबसे नज़दीकी चीज है dict.update()
:
>>> capitals.update({
... "Lebanon": "Beirut",
... "Norway": "Oslo",
... "France": "Paris",
... })
>>> [capitals.get(k) for k in ("Lebanon", "Norway", "Bahamas")]
['Beirut', 'Oslo', 'Nassau']
हम .get()
. का उपयोग करते हैं के बजाय .__getitem__()
जब कोई कुंजी नहीं मिलती है तो रेडिस के व्यवहार की नकल करने के लिए एक शून्य जैसा मान लौटाता है।
तीसरे उदाहरण के रूप में, EXISTS
कमांड वही करता है जो यह लगता है, जो यह जांचना है कि कोई कुंजी मौजूद है या नहीं:
127.0.0.1:6379> EXISTS Norway
(integer) 1
127.0.0.1:6379> EXISTS Sweden
(integer) 0
पायथन में in
है एक ही चीज़ का परीक्षण करने के लिए कीवर्ड, जो dict.__contains__(key)
. के लिए रूट करता है :
>>> "Norway" in capitals
True
>>> "Sweden" in capitals
False
ये कुछ उदाहरण देशी पायथन का उपयोग करके दिखाने के लिए हैं, कुछ सामान्य रेडिस कमांड के साथ उच्च स्तर पर क्या हो रहा है। पायथन उदाहरणों के लिए यहां कोई क्लाइंट-सर्वर घटक नहीं है, और redis-py
अभी तक तस्वीर में प्रवेश नहीं किया है। यह केवल उदाहरण के द्वारा रेडिस की कार्यक्षमता दिखाने के लिए है।
यहां आपके द्वारा देखे गए कुछ रेडिस कमांड और उनके कार्यात्मक पायथन समकक्षों का सारांश दिया गया है:
capitals["Bahamas"] = "Nassau"
capitals.get("Croatia")
capitals.update(
{
"Lebanon": "Beirut",
"Norway": "Oslo",
"France": "Paris",
}
)
[capitals[k] for k in ("Lebanon", "Norway", "Bahamas")]
"Norway" in capitals
पायथन रेडिस क्लाइंट लाइब्रेरी, redis-py
, जिसे आप इस लेख में जल्द ही समझेंगे, चीजों को अलग तरह से करता है। यह एक रेडिस सर्वर के लिए एक वास्तविक टीसीपी कनेक्शन को इनकैप्सुलेट करता है और कच्चे कमांड भेजता है, क्योंकि बाइट्स को रेडिस सीरियलाइजेशन प्रोटोकॉल (आरईएसपी) का उपयोग करके सर्वर पर क्रमबद्ध किया जाता है। इसके बाद यह कच्चा उत्तर लेता है और इसे वापस एक पायथन ऑब्जेक्ट जैसे bytes
. में पार्स करता है , int
, या यहां तक कि datetime.datetime
।
नोट :अब तक, आप इंटरैक्टिव redis-cli
के माध्यम से Redis सर्वर से बात कर रहे हैं आरईपीएल। आप सीधे कमांड भी जारी कर सकते हैं, ठीक उसी तरह जैसे आप किसी स्क्रिप्ट का नाम python
को देते हैं। निष्पादन योग्य, जैसे python myscript.py
।
अब तक, आपने रेडिस के कुछ मूलभूत डेटा प्रकार देखे हैं, जो कि स्ट्रिंग:स्ट्रिंग की मैपिंग है। . हालांकि यह की-वैल्यू पेयर अधिकांश की-वैल्यू स्टोर्स में आम है, रेडिस कई अन्य संभावित मूल्य प्रकार प्रदान करता है, जिन्हें आप आगे देखेंगे।
पायथन बनाम रेडिस में अधिक डेटा प्रकार
इससे पहले कि आप redis-py
को सक्रिय करें पायथन क्लाइंट, यह कुछ और रेडिस डेटा प्रकारों पर एक बुनियादी समझ रखने में भी मदद करता है। स्पष्ट होने के लिए, सभी रेडिस कुंजियाँ तार हैं। यह वह मान है जो अब तक के उदाहरणों में उपयोग किए गए स्ट्रिंग मानों के अलावा डेटा प्रकारों (या संरचनाओं) को भी ले सकता है।
एक हैश स्ट्रिंग:स्ट्रिंग . की मैपिंग है , जिसे फ़ील्ड-मान . कहा जाता है जोड़े, जो एक शीर्ष-स्तरीय कुंजी के नीचे बैठता है:
127.0.0.1:6379> HSET realpython url "https://realpython.com/"
(integer) 1
127.0.0.1:6379> HSET realpython github realpython
(integer) 1
127.0.0.1:6379> HSET realpython fullname "Real Python"
(integer) 1
यह एक कुंजी . के लिए तीन फ़ील्ड-मान युग्म सेट करता है , "realpython"
. यदि आप पायथन की शब्दावली और वस्तुओं के अभ्यस्त हैं, तो यह भ्रमित करने वाला हो सकता है। एक रेडिस हैश मोटे तौर पर एक पायथन dict
के समान है जो एक स्तर की गहराई में नेस्टेड है:
data = {
"realpython": {
"url": "https://realpython.com/",
"github": "realpython",
"fullname": "Real Python",
}
}
रेडिस के क्षेत्र उपरोक्त आंतरिक शब्दकोश में प्रत्येक नेस्टेड की-वैल्यू जोड़ी की पायथन कुंजी के समान हैं। Redis कुंजी . शब्द सुरक्षित रखता है शीर्ष-स्तरीय डेटाबेस कुंजी के लिए जो स्वयं हैश संरचना रखती है।
ठीक वैसे ही जैसे MSET
है बुनियादी स्ट्रिंग:स्ट्रिंग . के लिए की-वैल्यू पेयर, HMSET
भी है हैश के लिए भीतर . कई जोड़े सेट करने के लिए हैश वैल्यू ऑब्जेक्ट:
127.0.0.1:6379> HMSET pypa url "https://www.pypa.io/" github pypa fullname "Python Packaging Authority"
OK
127.0.0.1:6379> HGETALL pypa
1) "url"
2) "https://www.pypa.io/"
3) "github"
4) "pypa"
5) "fullname"
6) "Python Packaging Authority"
HMSET
का उपयोग करना जिस तरह से हमने data
assigned असाइन किया है, वह संभवत:उसके समानांतर है प्रत्येक नेस्टेड जोड़ी को सेट करने के बजाय, जैसा कि HSET
. के साथ किया जाता है, ऊपर एक नेस्टेड शब्दकोश में .
दो अतिरिक्त मान प्रकार हैं सूचियां और सेट , जो हैश या स्ट्रिंग की जगह रेडिस मान के रूप में ले सकता है। वे मोटे तौर पर वही हैं जो वे पसंद करते हैं, इसलिए मैं अतिरिक्त उदाहरणों के साथ आपका समय नहीं लूंगा। हैश, सूचियाँ और सेट प्रत्येक में कुछ कमांड होते हैं जो उस दिए गए डेटा प्रकार के लिए विशेष होते हैं, जो कुछ मामलों में उनके प्रारंभिक अक्षर द्वारा दर्शाए जाते हैं:
-
हैश: हैश पर काम करने के लिए कमांड
H
. से शुरू होते हैं , जैसेHSET
,HGET
, याHMSET
। -
सेट: सेट पर काम करने के लिए कमांड
S
. से शुरू होते हैं , जैसेSCARD
, जो किसी दिए गए कुंजी के अनुरूप सेट मान पर तत्वों की संख्या प्राप्त करता है। -
सूचियां: सूचियों पर काम करने के लिए कमांड
L
. से शुरू होते हैं याR
. उदाहरणों में शामिल हैंLPOP
औरRPUSH
.L
याR
संदर्भित करता है कि सूची के किस तरफ संचालित होता है। कुछ लिस्ट कमांड के सामनेB
. भी होता है , जिसका अर्थ है अवरुद्ध करना . एक अवरुद्ध ऑपरेशन अन्य कार्यों को निष्पादित करते समय इसे बाधित नहीं होने देता है। उदाहरण के लिए,BLPOP
एक सूची संरचना पर एक अवरुद्ध बायाँ-पॉप निष्पादित करता है।
नोट: रेडिस की सूची प्रकार की एक उल्लेखनीय विशेषता यह है कि यह एक सरणी के बजाय एक लिंक की गई सूची है। इसका मतलब यह है कि एक मनमाना इंडेक्स नंबर पर इंडेक्सिंग करते समय ओ (एन) जोड़ना ओ (एन) है।
यहां उन आदेशों की त्वरित सूची दी गई है जो विशेष रूप से रेडिस में स्ट्रिंग, हैश, सूची और सेट डेटा प्रकारों के लिए हैं:
टाइप करें | कमांड |
---|---|
सेट | SADD , SCARD , SDIFF , SDIFFSTORE , SINTER , SINTERSTORE , SISMEMBER , SMEMBERS , SMOVE , SPOP , SRANDMEMBER , SREM , SSCAN , SUNION , SUNIONSTORE |
हैश | HDEL , HEXISTS , HGET , HGETALL , HINCRBY , HINCRBYFLOAT , HKEYS , HLEN , HMGET , HMSET , HSCAN , HSET , HSETNX , HSTRLEN , HVALS |
सूचियां | BLPOP , BRPOP , BRPOPLPUSH , LINDEX , LINSERT , LLEN , LPOP , LPUSH , LPUSHX , LRANGE , LREM , LSET , LTRIM , RPOP , RPOPLPUSH , RPUSH , RPUSHX |
स्ट्रिंग्स | APPEND , BITCOUNT , BITFIELD , BITOP , BITPOS , DECR , DECRBY , GET , GETBIT , GETRANGE , GETSET , INCR , INCRBY , INCRBYFLOAT , MGET , MSET , MSETNX , PSETEX , SET , SETBIT , SETEX , SETNX , SETRANGE , STRLEN |
यह तालिका रेडिस कमांड और प्रकारों की पूरी तस्वीर नहीं है। अधिक उन्नत डेटा प्रकारों का एक स्मोर्गसबॉर्ड है, जैसे कि भू-स्थानिक आइटम, सॉर्ट किए गए सेट और हाइपरलॉग। रेडिस कमांड पेज पर, आप डेटा-स्ट्रक्चर ग्रुप द्वारा फ़िल्टर कर सकते हैं। Redis डेटा प्रकारों का डेटा प्रकार सारांश और परिचय भी है।
चूंकि हम पायथन में चीजों को करने के लिए स्विच करने जा रहे हैं, अब आप FLUSHDB
के साथ अपना खिलौना डेटाबेस साफ़ कर सकते हैं और redis-cli
से बाहर निकलें आरईपीएल:
127.0.0.1:6379> FLUSHDB
OK
127.0.0.1:6379> QUIT
यह आपको आपके शेल प्रॉम्प्ट पर वापस लाएगा। आप redis-server
छोड़ सकते हैं पृष्ठभूमि में चल रहा है, क्योंकि आपको बाकी ट्यूटोरियल के लिए भी इसकी आवश्यकता होगी।
redis-py
का उपयोग करना :पायथन में रेडिस
अब जब आपने Redis की कुछ बुनियादी बातों में महारत हासिल कर ली है, तो redis-py
में कूदने का समय आ गया है , पायथन क्लाइंट जो आपको उपयोगकर्ता के अनुकूल पायथन एपीआई से रेडिस से बात करने देता है।
पहले चरण
redis-py
एक अच्छी तरह से स्थापित पायथन क्लाइंट लाइब्रेरी है जो आपको रेडिस सर्वर से सीधे पायथन कॉल के माध्यम से बात करने देती है:
$ python -m pip install redis
इसके बाद, सुनिश्चित करें कि आपका रेडिस सर्वर अभी भी चालू है और पृष्ठभूमि में चल रहा है। आप pgrep redis-server
से जांच कर सकते हैं , और यदि आप खाली हाथ आते हैं, तो स्थानीय सर्वर को redis-server /etc/redis/6379.conf
के साथ पुनरारंभ करें ।
अब, आइए चीजों के पायथन-केंद्रित भाग में आते हैं। यह रहा redis-py
का "हैलो वर्ल्ड" :
1>>> import redis
2>>> r = redis.Redis()
3>>> r.mset({"Croatia": "Zagreb", "Bahamas": "Nassau"})
4True
5>>> r.get("Bahamas")
6b'Nassau'
Redis
, लाइन 2 में उपयोग किया जाता है, पैकेज और वर्कहॉर्स का केंद्रीय वर्ग है जिसके द्वारा आप किसी भी रेडिस कमांड को निष्पादित (लगभग) करते हैं। टीसीपी सॉकेट कनेक्शन और पुन:उपयोग आपके लिए पर्दे के पीछे किया जाता है, और आप क्लास इंस्टेंस पर विधियों का उपयोग करके रेडिस कमांड को कॉल करते हैं r
।
यह भी ध्यान दें कि लौटाई गई वस्तु का प्रकार, b'Nassau'
लाइन 6 में, पायथन का bytes
है टाइप करें, न कि str
. यह bytes
है के बजाय str
यह redis-py
में सबसे आम रिटर्न प्रकार है , इसलिए आपको r.get("Bahamas").decode("utf-8")
पर कॉल करने की आवश्यकता हो सकती है आप वास्तव में लौटे बाइटस्ट्रिंग के साथ क्या करना चाहते हैं इसके आधार पर।
क्या उपरोक्त कोड परिचित दिखता है? लगभग सभी मामलों में विधियां रेडिस कमांड के नाम से मेल खाती हैं जो एक ही काम करती है। यहां, आपने r.mset()
. को कॉल किया और r.get()
, जो MSET
. के अनुरूप है और GET
देशी रेडिस एपीआई में।
इसका मतलब यह भी है कि HGETALL
हो जाता है r.hgetall()
, PING
हो जाता है r.ping()
, और इसी तरह। कुछ अपवाद हैं, लेकिन नियम अधिकांश आदेशों के लिए मान्य है।
जबकि रेडिस कमांड तर्क आमतौर पर एक समान दिखने वाली विधि हस्ताक्षर में अनुवाद करते हैं, वे पायथन ऑब्जेक्ट लेते हैं। उदाहरण के लिए, r.mset()
. पर कॉल करें ऊपर के उदाहरण में एक पायथन dict
का उपयोग करता है बाइटस्ट्रिंग के अनुक्रम के बजाय इसके पहले तर्क के रूप में।
हमने Redis
. बनाया है उदाहरण r
बिना किसी तर्क के, लेकिन यदि आपको उनकी आवश्यकता हो तो यह कई मापदंडों के साथ बंडल में आता है:
# From redis/client.py
class Redis(object):
def __init__(self, host='localhost', port=6379,
db=0, password=None, socket_timeout=None,
# ...
आप देख सकते हैं कि डिफ़ॉल्ट होस्टनाम:पोर्ट जोड़ी है localhost:6379
, जो हमारे स्थानीय रूप से रखे गए redis-server
. के मामले में ठीक वही है जो हमें चाहिए उदाहरण।
db
पैरामीटर डेटाबेस नंबर है। आप एक साथ रेडिस में कई डेटाबेस प्रबंधित कर सकते हैं, और प्रत्येक को एक पूर्णांक द्वारा पहचाना जाता है। डेटाबेस की अधिकतम संख्या डिफ़ॉल्ट रूप से 16 है।
जब आप बस redis-cli
चलाते हैं कमांड लाइन से, यह आपको डेटाबेस 0 पर शुरू करता है। -n
. का उपयोग करें एक नया डेटाबेस शुरू करने के लिए ध्वजांकित करें, जैसा कि redis-cli -n 5
. में है ।
अनुमत कुंजी प्रकार
एक बात जो जानने योग्य है वह यह है कि redis-py
इसके लिए आवश्यक है कि आप इसे bytes
कीज़ पास करें , str
, int
, या float
. (यह इनमें से अंतिम 3 प्रकारों को bytes
. में बदल देगा सर्वर पर भेजने से पहले।)
ऐसे मामले पर विचार करें जहां आप कैलेंडर तिथियों को कुंजियों के रूप में उपयोग करना चाहते हैं:
>>>>>> import datetime
>>> today = datetime.date.today()
>>> visitors = {"dan", "jon", "alex"}
>>> r.sadd(today, *visitors)
Traceback (most recent call last):
# ...
redis.exceptions.DataError: Invalid input of type: 'date'.
Convert to a byte, string or number first.
आपको पाइथन date
को स्पष्ट रूप से बदलना होगा str
. पर आपत्ति करें , जो आप .isoformat()
. के साथ कर सकते हैं :
>>> stoday = today.isoformat() # Python 3.7+, or use str(today)
>>> stoday
'2019-03-10'
>>> r.sadd(stoday, *visitors) # sadd: set-add
3
>>> r.smembers(stoday)
{b'dan', b'alex', b'jon'}
>>> r.scard(today.isoformat())
3
संक्षेप में, रेडिस स्वयं केवल तारों को चाबियों के रूप में अनुमति देता है। redis-py
यह पाइथन के प्रकारों को स्वीकार करने में थोड़ा अधिक उदार है, हालांकि यह अंततः रेडिस सर्वर पर भेजने से पहले सब कुछ बाइट्स में परिवर्तित कर देता है।
उदाहरण:PyHats.com
एक पूर्ण उदाहरण को तोड़ने का समय आ गया है। आइए मान लें कि हमने एक आकर्षक वेबसाइट, PyHats.com शुरू करने का फैसला किया है, जो उन्हें खरीदने वाले किसी भी व्यक्ति को अपमानजनक रूप से अधिक मूल्य वाली टोपियां बेचती है, और आपको साइट बनाने के लिए किराए पर लेती है।
आप PyHats.com के लिए कुछ उत्पाद कैटलॉग, इन्वेंट्री और बॉट ट्रैफ़िक डिटेक्शन को संभालने के लिए Redis का उपयोग करेंगे।
साइट के लिए यह पहला दिन है, और हम तीन सीमित-संस्करण हैट बेचने जा रहे हैं। प्रत्येक टोपी फ़ील्ड-वैल्यू जोड़े के रेडिस हैश में रखी जाती है, और हैश में एक कुंजी होती है जो एक प्रीफ़िक्स्ड रैंडम पूर्णांक होता है, जैसे कि hat:56854717
. hat:
. का उपयोग करना रेडिस डेटाबेस में एक प्रकार का नेमस्पेस बनाने के लिए प्रीफिक्स रेडिस कन्वेंशन है:
import random
random.seed(444)
hats = {f"hat:{random.getrandbits(32)}": i for i in (
{
"color": "black",
"price": 49.99,
"style": "fitted",
"quantity": 1000,
"npurchased": 0,
},
{
"color": "maroon",
"price": 59.99,
"style": "hipster",
"quantity": 500,
"npurchased": 0,
},
{
"color": "green",
"price": 99.99,
"style": "baseball",
"quantity": 200,
"npurchased": 0,
})
}
आइए डेटाबेस से शुरू करते हैं 1
चूंकि हमने डेटाबेस 0
. का उपयोग किया है पिछले उदाहरण में:
>>> r = redis.Redis(db=1)
रेडिस में इस डेटा का प्रारंभिक लेखन करने के लिए, हम .hmset()
. का उपयोग कर सकते हैं (हैश मल्टी-सेट), इसे प्रत्येक शब्दकोश के लिए बुला रहा है। "मल्टी" कई फ़ील्ड-वैल्यू जोड़े सेट करने का एक संदर्भ है, जहां इस मामले में "फ़ील्ड" hats
में किसी भी नेस्टेड शब्दकोश की कुंजी से मेल खाती है :
1>>> with r.pipeline() as pipe:
2... for h_id, hat in hats.items():
3... pipe.hmset(h_id, hat)
4... pipe.execute()
5Pipeline<ConnectionPool<Connection<host=localhost,port=6379,db=1>>>
6Pipeline<ConnectionPool<Connection<host=localhost,port=6379,db=1>>>
7Pipeline<ConnectionPool<Connection<host=localhost,port=6379,db=1>>>
8[True, True, True]
9
10>>> r.bgsave()
11True
उपरोक्त कोड ब्लॉक रेडिस पाइपलाइनिंग . की अवधारणा का भी परिचय देता है , जो आपके रेडिस सर्वर से डेटा लिखने या पढ़ने के लिए आवश्यक राउंड-ट्रिप लेनदेन की संख्या को कम करने का एक तरीका है। अगर आपने अभी r.hmset()
. को कॉल किया होता तीन बार, फिर इसके लिए लिखी गई प्रत्येक पंक्ति के लिए आगे-पीछे राउंड ट्रिप ऑपरेशन की आवश्यकता होगी।
एक पाइपलाइन के साथ, सभी कमांड क्लाइंट साइड पर बफ़र किए जाते हैं और फिर एक ही बार में pipe.hmset()
का उपयोग करके एक ही बार में भेज दिए जाते हैं। पंक्ति 3 में। यही कारण है कि तीन True
जब आप pipe.execute()
. को कॉल करते हैं, तो प्रतिक्रियाएं एक साथ वापस आ जाती हैं लाइन 4 में। जल्द ही आपको पाइपलाइन के लिए अधिक उन्नत उपयोग का मामला दिखाई देगा।
नोट :Redis डॉक्स redis-cli
. के साथ ऐसा ही करने का एक उदाहरण प्रदान करता है , जहां आप बड़े पैमाने पर सम्मिलन करने के लिए स्थानीय फ़ाइल की सामग्री को पाइप कर सकते हैं।
आइए एक त्वरित जांच करें कि हमारे रेडिस डेटाबेस में सब कुछ है:
>>>>>> pprint(r.hgetall("hat:56854717"))
{b'color': b'green',
b'npurchased': b'0',
b'price': b'99.99',
b'quantity': b'200',
b'style': b'baseball'}
>>> r.keys() # Careful on a big DB. keys() is O(N)
[b'56854717', b'1236154736', b'1326692461']
पहली चीज़ जिसका हम अनुकरण करना चाहते हैं, वह यह है कि जब कोई उपयोगकर्ता खरीदारी . पर क्लिक करता है तो क्या होता है . यदि आइटम स्टॉक में है, तो उसका npurchased
बढ़ाएं 1 से और इसकी quantity
घटाएं (इन्वेंट्री) 1 से। आप .hincrby()
. का उपयोग कर सकते हैं ऐसा करने के लिए:
>>> r.hincrby("hat:56854717", "quantity", -1)
199
>>> r.hget("hat:56854717", "quantity")
b'199'
>>> r.hincrby("hat:56854717", "npurchased", 1)
1
नोट :HINCRBY
अभी भी एक हैश मान पर काम करता है जो एक स्ट्रिंग है, लेकिन यह ऑपरेशन को निष्पादित करने के लिए स्ट्रिंग को आधार -10 64-बिट हस्ताक्षरित पूर्णांक के रूप में व्याख्या करने का प्रयास करता है।
यह अन्य डेटा संरचनाओं के लिए वृद्धि और कमी से संबंधित अन्य आदेशों पर लागू होता है, अर्थात् INCR
, INCRBY
, INCRBYFLOAT
, ZINCRBY
, और HINCRBYFLOAT
. यदि मान पर स्ट्रिंग को पूर्णांक के रूप में प्रदर्शित नहीं किया जा सकता है, तो आपको एक त्रुटि मिलेगी।
हालांकि यह वास्तव में इतना आसान नहीं है। quantity
बदलना और npurchased
कोड की दो पंक्तियों में इस वास्तविकता को छुपाया जाता है कि एक क्लिक, खरीदारी और भुगतान इससे कहीं अधिक की आवश्यकता है। हमें यह सुनिश्चित करने के लिए कुछ और जाँच करने की ज़रूरत है कि हम किसी के पास हल्का बटुआ और टोपी न छोड़े:
- चरण 1: Check if the item is in stock, or otherwise raise an exception on the backend.
- Step 2: If it is in stock, then execute the transaction, decrease the
quantity
field, and increase thenpurchased
फ़ील्ड. - Step 3: Be alert for any changes that alter the inventory in between the first two steps (a race condition).
Step 1 is relatively straightforward:it consists of an .hget()
to check the available quantity.
Step 2 is a little bit more involved. The pair of increase and decrease operations need to be executed atomically :either both should be completed successfully, or neither should be (in the case that at least one fails).
With client-server frameworks, it’s always crucial to pay attention to atomicity and look out for what could go wrong in instances where multiple clients are trying to talk to the server at once. The answer to this in Redis is to use a transaction block, meaning that either both or neither of the commands get through.
In redis-py
, Pipeline
is a transactional pipeline class by default. This means that, even though the class is actually named for something else (pipelining), it can be used to create a transaction block also.
In Redis, a transaction starts with MULTI
and ends with EXEC
:
1127.0.0.1:6379> MULTI
2127.0.0.1:6379> HINCRBY 56854717 quantity -1
3127.0.0.1:6379> HINCRBY 56854717 npurchased 1
4127.0.0.1:6379> EXEC
MULTI
(Line 1) marks the start of the transaction, and EXEC
(Line 4) marks the end. Everything in between is executed as one all-or-nothing buffered sequence of commands. This means that it will be impossible to decrement quantity
(Line 2) but then have the balancing npurchased
increment operation fail (Line 3).
Let’s circle back to Step 3:we need to be aware of any changes that alter the inventory in between the first two steps.
Step 3 is the trickiest. Let’s say that there is one lone hat remaining in our inventory. In between the time that User A checks the quantity of hats remaining and actually processes their transaction, User B also checks the inventory and finds likewise that there is one hat listed in stock. Both users will be allowed to purchase the hat, but we have 1 hat to sell, not 2, so we’re on the hook and one user is out of their money. Not good.
Redis has a clever answer for the dilemma in Step 3:it’s called optimistic locking , and is different than how typical locking works in an RDBMS such as PostgreSQL. Optimistic locking, in a nutshell, means that the calling function (client) does not acquire a lock, but rather monitors for changes in the data it is writing to during the time it would have held a lock . If there’s a conflict during that time, the calling function simply tries the whole process again.
You can effect optimistic locking by using the WATCH
command (.watch()
in redis-py
), which provides a check-and-set behavior.
Let’s introduce a big chunk of code and walk through it afterwards step by step. You can picture buyitem()
as being called any time a user clicks on a Buy Now or Purchase बटन। Its purpose is to confirm the item is in stock and take an action based on that result, all in a safe manner that looks out for race conditions and retries if one is detected:
1import logging
2import redis
3
4logging.basicConfig()
5
6class OutOfStockError(Exception):
7 """Raised when PyHats.com is all out of today's hottest hat"""
8
9def buyitem(r: redis.Redis, itemid: int) -> None:
10 with r.pipeline() as pipe:
11 error_count = 0
12 while True:
13 try:
14 # Get available inventory, watching for changes
15 # related to this itemid before the transaction
16 pipe.watch(itemid)
17 nleft: bytes = r.hget(itemid, "quantity")
18 if nleft > b"0":
19 pipe.multi()
20 pipe.hincrby(itemid, "quantity", -1)
21 pipe.hincrby(itemid, "npurchased", 1)
22 pipe.execute()
23 break
24 else:
25 # Stop watching the itemid and raise to break out
26 pipe.unwatch()
27 raise OutOfStockError(
28 f"Sorry, {itemid} is out of stock!"
29 )
30 except redis.WatchError:
31 # Log total num. of errors by this user to buy this item,
32 # then try the same process again of WATCH/HGET/MULTI/EXEC
33 error_count += 1
34 logging.warning(
35 "WatchError #%d: %s; retrying",
36 error_count, itemid
37 )
38 return None
The critical line occurs at Line 16 with pipe.watch(itemid)
, which tells Redis to monitor the given itemid
for any changes to its value. The program checks the inventory through the call to r.hget(itemid, "quantity")
, in Line 17:
16pipe.watch(itemid)
17nleft: bytes = r.hget(itemid, "quantity")
18if nleft > b"0":
19 # Item in stock. Proceed with transaction.
If the inventory gets touched during this short window between when the user checks the item stock and tries to purchase it, then Redis will return an error, and redis-py
will raise a WatchError
(Line 30). That is, if any of the hash pointed to by itemid
changes after the .hget()
call but before the subsequent .hincrby()
calls in Lines 20 and 21, then we’ll re-run the whole process in another iteration of the while True
loop as a result.
This is the “optimistic” part of the locking:rather than letting the client have a time-consuming total lock on the database through the getting and setting operations, we leave it up to Redis to notify the client and user only in the case that calls for a retry of the inventory check.
One key here is in understanding the difference between client-side and server-side संचालन:
nleft = r.hget(itemid, "quantity")
This Python assignment brings the result of r.hget()
client-side. Conversely, methods that you call on pipe
effectively buffer all of the commands into one, and then send them to the server in a single request:
16pipe.multi()
17pipe.hincrby(itemid, "quantity", -1)
18pipe.hincrby(itemid, "npurchased", 1)
19pipe.execute()
No data comes back to the client side in the middle of the transactional pipeline. You need to call .execute()
(Line 19) to get the sequence of results back all at once.
Even though this block contains two commands, it consists of exactly one round-trip operation from client to server and back.
This means that the client can’t immediately use the result of pipe.hincrby(itemid, "quantity", -1)
, from Line 20, because methods on a Pipeline
return just the pipe
instance itself. We haven’t asked anything from the server at this point. While normally .hincrby()
returns the resulting value, you can’t immediately reference it on the client side until the entire transaction is completed.
There’s a catch-22:this is also why you can’t put the call to .hget()
into the transaction block. If you did this, then you’d be unable to know if you want to increment the npurchased
field yet, since you can’t get real-time results from commands that are inserted into a transactional pipeline.
Finally, if the inventory sits at zero, then we UNWATCH
the item ID and raise an OutOfStockError
(Line 27), ultimately displaying that coveted Sold Out page that will make our hat buyers desperately want to buy even more of our hats at ever more outlandish prices:
24else:
25 # Stop watching the itemid and raise to break out
26 pipe.unwatch()
27 raise OutOfStockError(
28 f"Sorry, {itemid} is out of stock!"
29 )
Here’s an illustration. Keep in mind that our starting quantity is 199
for hat 56854717 since we called .hincrby()
ऊपर। Let’s mimic 3 purchases, which should modify the quantity
and npurchased
फ़ील्ड:
>>> buyitem(r, "hat:56854717")
>>> buyitem(r, "hat:56854717")
>>> buyitem(r, "hat:56854717")
>>> r.hmget("hat:56854717", "quantity", "npurchased") # Hash multi-get
[b'196', b'4']
Now, we can fast-forward through more purchases, mimicking a stream of purchases until the stock depletes to zero. Again, picture these coming from a whole bunch of different clients rather than just one Redis
उदाहरण:
>>> # Buy remaining 196 hats for item 56854717 and deplete stock to 0
>>> for _ in range(196):
... buyitem(r, "hat:56854717")
>>> r.hmget("hat:56854717", "quantity", "npurchased")
[b'0', b'200']
Now, when some poor user is late to the game, they should be met with an OutOfStockError
that tells our application to render an error message page on the frontend:
>>> buyitem(r, "hat:56854717")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 20, in buyitem
__main__.OutOfStockError: Sorry, hat:56854717 is out of stock!
Looks like it’s time to restock.
Using Key Expiry
Let’s introduce key expiry , which is another distinguishing feature in Redis. When you expire a key, that key and its corresponding value will be automatically deleted from the database after a certain number of seconds or at a certain timestamp.
In redis-py
, one way that you can accomplish this is through .setex()
, which lets you set a basic string:string key-value pair with an expiration:
1>>> from datetime import timedelta
2
3>>> # setex: "SET" with expiration
4>>> r.setex(
5... "runner",
6... timedelta(minutes=1),
7... value="now you see me, now you don't"
8... )
9True
You can specify the second argument as a number in seconds or a timedelta
object, as in Line 6 above. I like the latter because it seems less ambiguous and more deliberate.
There are also methods (and corresponding Redis commands, of course) to get the remaining lifetime (time-to-live ) of a key that you’ve set to expire:
>>>>>> r.ttl("runner") # "Time To Live", in seconds
58
>>> r.pttl("runner") # Like ttl, but milliseconds
54368
Below, you can accelerate the window until expiration, and then watch the key expire, after which r.get()
will return None
and .exists()
will return 0
:
>>> r.get("runner") # Not expired yet
b"now you see me, now you don't"
>>> r.expire("runner", timedelta(seconds=3)) # Set new expire window
True
>>> # Pause for a few seconds
>>> r.get("runner")
>>> r.exists("runner") # Key & value are both gone (expired)
0
The table below summarizes commands related to key-value expiration, including the ones covered above. The explanations are taken directly from redis-py
method docstrings:
Signature | Purpose |
---|---|
r.setex(name, time, value) | Sets the value of key name to value that expires in time seconds, where time can be represented by an int or a Python timedelta object |
r.psetex(name, time_ms, value) | Sets the value of key name to value that expires in time_ms milliseconds, where time_ms can be represented by an int or a Python timedelta object |
r.expire(name, time) | Sets an expire flag on key name for time seconds, where time can be represented by an int or a Python timedelta object |
r.expireat(name, when) | Sets an expire flag on key name , where when can be represented as an int indicating Unix time or a Python datetime object |
r.persist(name) | Removes an expiration on name |
r.pexpire(name, time) | Sets an expire flag on key name for time milliseconds, and time can be represented by an int or a Python timedelta object |
r.pexpireat(name, when) | Sets an expire flag on key name , where when can be represented as an int representing Unix time in milliseconds (Unix time * 1000) or a Python datetime object |
r.pttl(name) | Returns the number of milliseconds until the key name will expire |
r.ttl(name) | Returns the number of seconds until the key name will expire |
PyHats.com, Part 2
A few days after its debut, PyHats.com has attracted so much hype that some enterprising users are creating bots to buy hundreds of items within seconds, which you’ve decided isn’t good for the long-term health of your hat business.
Now that you’ve seen how to expire keys, let’s put it to use on the backend of PyHats.com.
We’re going to create a new Redis client that acts as a consumer (or watcher) and processes a stream of incoming IP addresses, which in turn may come from multiple HTTPS connections to the website’s server.
The watcher’s goal is to monitor a stream of IP addresses from multiple sources, keeping an eye out for a flood of requests from a single address within a suspiciously short amount of time.
Some middleware on the website server pushes all incoming IP addresses into a Redis list with .lpush()
. Here’s a crude way of mimicking some incoming IPs, using a fresh Redis database:
>>> r = redis.Redis(db=5)
>>> r.lpush("ips", "51.218.112.236")
1
>>> r.lpush("ips", "90.213.45.98")
2
>>> r.lpush("ips", "115.215.230.176")
3
>>> r.lpush("ips", "51.218.112.236")
4
As you can see, .lpush()
returns the length of the list after the push operation succeeds. Each call of .lpush()
puts the IP at the beginning of the Redis list that is keyed by the string "ips"
।
In this simplified simulation, the requests are all technically from the same client, but you can think of them as potentially coming from many different clients and all being pushed to the same database on the same Redis server.
Now, open up a new shell tab or window and launch a new Python REPL. In this shell, you’ll create a new client that serves a very different purpose than the rest, which sits in an endless while True
loop and does a blocking left-pop BLPOP
call on the ips
list, processing each address:
1# New shell window or tab
2
3import datetime
4import ipaddress
5
6import redis
7
8# Where we put all the bad egg IP addresses
9blacklist = set()
10MAXVISITS = 15
11
12ipwatcher = redis.Redis(db=5)
13
14while True:
15 _, addr = ipwatcher.blpop("ips")
16 addr = ipaddress.ip_address(addr.decode("utf-8"))
17 now = datetime.datetime.utcnow()
18 addrts = f"{addr}:{now.minute}"
19 n = ipwatcher.incrby(addrts, 1)
20 if n >= MAXVISITS:
21 print(f"Hat bot detected!: {addr}")
22 blacklist.add(addr)
23 else:
24 print(f"{now}: saw {addr}")
25 _ = ipwatcher.expire(addrts, 60)
Let’s walk through a few important concepts.
The ipwatcher
acts like a consumer, sitting around and waiting for new IPs to be pushed on the "ips"
Redis list. It receives them as bytes
, such as b”51.218.112.236”, and makes them into a more proper address object with the ipaddress
मॉड्यूल:
15_, addr = ipwatcher.blpop("ips")
16addr = ipaddress.ip_address(addr.decode("utf-8"))
Then you form a Redis string key using the address and minute of the hour at which the ipwatcher
saw the address, incrementing the corresponding count by 1
and getting the new count in the process:
17now = datetime.datetime.utcnow()
18addrts = f"{addr}:{now.minute}"
19n = ipwatcher.incrby(addrts, 1)
If the address has been seen more than MAXVISITS
, then it looks as if we have a PyHats.com web scraper on our hands trying to create the next tulip bubble. Alas, we have no choice but to give this user back something like a dreaded 403 status code.
We use ipwatcher.expire(addrts, 60)
to expire the (address minute) combination 60 seconds from when it was last seen. This is to prevent our database from becoming clogged up with stale one-time page viewers.
If you execute this code block in a new shell, you should immediately see this output:
2019-03-11 15:10:41.489214: saw 51.218.112.236
2019-03-11 15:10:41.490298: saw 115.215.230.176
2019-03-11 15:10:41.490839: saw 90.213.45.98
2019-03-11 15:10:41.491387: saw 51.218.112.236
The output appears right away because those four IPs were sitting in the queue-like list keyed by "ips"
, waiting to be pulled out by our ipwatcher
. Using .blpop()
(or the BLPOP
command) will block until an item is available in the list, then pops it off. It behaves like Python’s Queue.get()
, which also blocks until an item is available.
Besides just spitting out IP addresses, our ipwatcher
has a second job. For a given minute of an hour (minute 1 through minute 60), ipwatcher
will classify an IP address as a hat-bot if it sends 15 or more GET
requests in that minute.
Switch back to your first shell and mimic a page scraper that blasts the site with 20 requests in a few milliseconds:
for _ in range(20):
r.lpush("ips", "104.174.118.18")
Finally, toggle back to the second shell holding ipwatcher
, and you should see an output like this:
2019-03-11 15:15:43.041363: saw 104.174.118.18
2019-03-11 15:15:43.042027: saw 104.174.118.18
2019-03-11 15:15:43.042598: saw 104.174.118.18
2019-03-11 15:15:43.043143: saw 104.174.118.18
2019-03-11 15:15:43.043725: saw 104.174.118.18
2019-03-11 15:15:43.044244: saw 104.174.118.18
2019-03-11 15:15:43.044760: saw 104.174.118.18
2019-03-11 15:15:43.045288: saw 104.174.118.18
2019-03-11 15:15:43.045806: saw 104.174.118.18
2019-03-11 15:15:43.046318: saw 104.174.118.18
2019-03-11 15:15:43.046829: saw 104.174.118.18
2019-03-11 15:15:43.047392: saw 104.174.118.18
2019-03-11 15:15:43.047966: saw 104.174.118.18
2019-03-11 15:15:43.048479: saw 104.174.118.18
Hat bot detected!: 104.174.118.18
Hat bot detected!: 104.174.118.18
Hat bot detected!: 104.174.118.18
Hat bot detected!: 104.174.118.18
Hat bot detected!: 104.174.118.18
Hat bot detected!: 104.174.118.18
Now, Ctrl +C out of the while True
loop and you’ll see that the offending IP has been added to your blacklist:
>>> blacklist
{IPv4Address('104.174.118.18')}
Can you find the defect in this detection system? The filter checks the minute as .minute
rather than the last 60 seconds (a rolling minute). Implementing a rolling check to monitor how many times a user has been seen in the last 60 seconds would be trickier. There’s a crafty solution using using Redis’ sorted sets at ClassDojo. Josiah Carlson’s Redis in Action also presents a more elaborate and general-purpose example of this section using an IP-to-location cache table.
Persistence and Snapshotting
One of the reasons that Redis is so fast in both read and write operations is that the database is held in memory (RAM) on the server. However, a Redis database can also be stored (persisted) to disk in a process called snapshotting. The point behind this is to keep a physical backup in binary format so that data can be reconstructed and put back into memory when needed, such as at server startup.
You already enabled snapshotting without knowing it when you set up basic configuration at the beginning of this tutorial with the save
विकल्प:
# /etc/redis/6379.conf
port 6379
daemonize yes
save 60 1
bind 127.0.0.1
tcp-keepalive 300
dbfilename dump.rdb
dir ./
rdbcompression yes
The format is save <seconds> <changes>
. This tells Redis to save the database to disk if both the given number of seconds and number of write operations against the database occurred. In this case, we’re telling Redis to save the database to disk every 60 seconds if at least one modifying write operation occurred in that 60-second timespan. This is a fairly aggressive setting versus the sample Redis config file, which uses these three save
directives:
# Default redis/redis.conf
save 900 1
save 300 10
save 60 10000
An RDB snapshot is a full (rather than incremental) point-in-time capture of the database. (RDB refers to a Redis Database File.) We also specified the directory and file name of the resulting data file that gets written:
# /etc/redis/6379.conf
port 6379
daemonize yes
save 60 1
bind 127.0.0.1
tcp-keepalive 300
dbfilename dump.rdb
dir ./
rdbcompression yes
This instructs Redis to save to a binary data file called dump.rdb
in the current working directory of wherever redis-server
was executed from:
$ file -b dump.rdb
data
You can also manually invoke a save with the Redis command BGSAVE
:
127.0.0.1:6379> BGSAVE
Background saving started
The “BG” in BGSAVE
indicates that the save occurs in the background. This option is available in a redis-py
method as well:
>>> r.lastsave() # Redis command: LASTSAVE
datetime.datetime(2019, 3, 10, 21, 56, 50)
>>> r.bgsave()
True
>>> r.lastsave()
datetime.datetime(2019, 3, 10, 22, 4, 2)
This example introduces another new command and method, .lastsave()
. In Redis, it returns the Unix timestamp of the last DB save, which Python gives back to you as a datetime
वस्तु। Above, you can see that the r.lastsave()
result changes as a result of r.bgsave()
.
r.lastsave()
will also change if you enable automatic snapshotting with the save
configuration option.
To rephrase all of this, there are two ways to enable snapshotting:
- Explicitly, through the Redis command
BGSAVE
orredis-py
method.bgsave()
- Implicitly, through the
save
configuration option (which you can also set with.config_set()
inredis-py
)
RDB snapshotting is fast because the parent process uses the fork()
system call to pass off the time-intensive write to disk to a child process, so that the parent process can continue on its way. This is what the background in BGSAVE
refers to.
There’s also SAVE
(.save()
in redis-py
), but this does a synchronous (blocking) save rather than using fork()
, so you shouldn’t use it without a specific reason.
Even though .bgsave()
occurs in the background, it’s not without its costs. The time for fork()
itself to occur can actually be substantial if the Redis database is large enough in the first place.
If this is a concern, or if you can’t afford to miss even a tiny slice of data lost due to the periodic nature of RDB snapshotting, then you should look into the append-only file (AOF) strategy that is an alternative to snapshotting. AOF copies Redis commands to disk in real time, allowing you to do a literal command-based reconstruction by replaying these commands.
Serialization Workarounds
Let’s get back to talking about Redis data structures. With its hash data structure, Redis in effect supports nesting one level deep:
127.0.0.1:6379> hset mykey field1 value1
The Python client equivalent would look like this:
r.hset("mykey", "field1", "value1")
Here, you can think of "field1": "value1"
as being the key-value pair of a Python dict, {"field1": "value1"}
, while mykey
is the top-level key:
Redis Command | Pure-Python Equivalent |
---|---|
r.set("key", "value") | r = {"key": "value"} |
r.hset("key", "field", "value") | r = {"key": {"field": "value"}} |
But what if you want the value of this dictionary (the Redis hash) to contain something other than a string, such as a list
or nested dictionary with strings as values?
Here’s an example using some JSON-like data to make the distinction clearer:
restaurant_484272 = {
"name": "Ravagh",
"type": "Persian",
"address": {
"street": {
"line1": "11 E 30th St",
"line2": "APT 1",
},
"city": "New York",
"state": "NY",
"zip": 10016,
}
}
Say that we want to set a Redis hash with the key 484272
and field-value pairs corresponding to the key-value pairs from restaurant_484272
. Redis does not support this directly, because restaurant_484272
is nested:
>>> r.hmset(484272, restaurant_484272)
Traceback (most recent call last):
# ...
redis.exceptions.DataError: Invalid input of type: 'dict'.
Convert to a byte, string or number first.
You can in fact make this work with Redis. There are two different ways to mimic nested data in redis-py
and Redis:
- Serialize the values into a string with something like
json.dumps()
- Use a delimiter in the key strings to mimic nesting in the values
Let’s take a look at an example of each.
Option 1:Serialize the Values Into a String
You can use json.dumps()
to serialize the dict
into a JSON-formatted string:
>>> import json
>>> r.set(484272, json.dumps(restaurant_484272))
True
If you call .get()
, the value you get back will be a bytes
object, so don’t forget to deserialize it to get back the original object. json.dumps()
and json.loads()
are inverses of each other, for serializing and deserializing data, respectively:
>>> from pprint import pprint
>>> pprint(json.loads(r.get(484272)))
{'address': {'city': 'New York',
'state': 'NY',
'street': '11 E 30th St',
'zip': 10016},
'name': 'Ravagh',
'type': 'Persian'}
This applies to any serialization protocol, with another common choice being yaml
:
>>> import yaml # python -m pip install PyYAML
>>> yaml.dump(restaurant_484272)
'address: {city: New York, state: NY, street: 11 E 30th St, zip: 10016}\nname: Ravagh\ntype: Persian\n'
No matter what serialization protocol you choose to go with, the concept is the same:you’re taking an object that is unique to Python and converting it to a bytestring that is recognized and exchangeable across multiple languages.
Option 2:Use a Delimiter in Key Strings
There’s a second option that involves mimicking “nestedness” by concatenating multiple levels of keys in a Python dict
. This consists of flattening the nested dictionary through recursion, so that each key is a concatenated string of keys, and the values are the deepest-nested values from the original dictionary. Consider our dictionary object restaurant_484272
:
restaurant_484272 = {
"name": "Ravagh",
"type": "Persian",
"address": {
"street": {
"line1": "11 E 30th St",
"line2": "APT 1",
},
"city": "New York",
"state": "NY",
"zip": 10016,
}
}
We want to get it into this form:
{
"484272:name": "Ravagh",
"484272:type": "Persian",
"484272:address:street:line1": "11 E 30th St",
"484272:address:street:line2": "APT 1",
"484272:address:city": "New York",
"484272:address:state": "NY",
"484272:address:zip": "10016",
}
That’s what setflat_skeys()
below does, with the added feature that it does inplace .set()
operations on the Redis
instance itself rather than returning a copy of the input dictionary:
1from collections.abc import MutableMapping
2
3def setflat_skeys(
4 r: redis.Redis,
5 obj: dict,
6 prefix: str,
7 delim: str = ":",
8 *,
9 _autopfix=""
10) -> None:
11 """Flatten `obj` and set resulting field-value pairs into `r`.
12
13 Calls `.set()` to write to Redis instance inplace and returns None.
14
15 `prefix` is an optional str that prefixes all keys.
16 `delim` is the delimiter that separates the joined, flattened keys.
17 `_autopfix` is used in recursive calls to created de-nested keys.
18
19 The deepest-nested keys must be str, bytes, float, or int.
20 Otherwise a TypeError is raised.
21 """
22 allowed_vtypes = (str, bytes, float, int)
23 for key, value in obj.items():
24 key = _autopfix + key
25 if isinstance(value, allowed_vtypes):
26 r.set(f"{prefix}{delim}{key}", value)
27 elif isinstance(value, MutableMapping):
28 setflat_skeys(
29 r, value, prefix, delim, _autopfix=f"{key}{delim}"
30 )
31 else:
32 raise TypeError(f"Unsupported value type: {type(value)}")
The function iterates over the key-value pairs of obj
, first checking the type of the value (Line 25) to see if it looks like it should stop recursing further and set that key-value pair. Otherwise, if the value looks like a dict
(Line 27), then it recurses into that mapping, adding the previously seen keys as a key prefix (Line 28).
Let’s see it at work:
>>>>>> r.flushdb() # Flush database: clear old entries
>>> setflat_skeys(r, restaurant_484272, 484272)
>>> for key in sorted(r.keys("484272*")): # Filter to this pattern
... print(f"{repr(key):35}{repr(r.get(key)):15}")
...
b'484272:address:city' b'New York'
b'484272:address:state' b'NY'
b'484272:address:street:line1' b'11 E 30th St'
b'484272:address:street:line2' b'APT 1'
b'484272:address:zip' b'10016'
b'484272:name' b'Ravagh'
b'484272:type' b'Persian'
>>> r.get("484272:address:street:line1")
b'11 E 30th St'
The final loop above uses r.keys("484272*")
, where "484272*"
is interpreted as a pattern and matches all keys in the database that begin with "484272"
।
Notice also how setflat_skeys()
calls just .set()
rather than .hset()
, because we’re working with plain string:string field-value pairs, and the 484272 ID key is prepended to each field string.
Encryption
Another trick to help you sleep well at night is to add symmetric encryption before sending anything to a Redis server. Consider this as an add-on to the security that you should make sure is in place by setting proper values in your Redis configuration. The example below uses the cryptography
package:
$ python -m pip install cryptography
To illustrate, pretend that you have some sensitive cardholder data (CD) that you never want to have sitting around in plaintext on any server, no matter what. Before caching it in Redis, you can serialize the data and then encrypt the serialized string using Fernet:
>>>>>> import json
>>> from cryptography.fernet import Fernet
>>> cipher = Fernet(Fernet.generate_key())
>>> info = {
... "cardnum": 2211849528391929,
... "exp": [2020, 9],
... "cv2": 842,
... }
>>> r.set(
... "user:1000",
... cipher.encrypt(json.dumps(info).encode("utf-8"))
... )
>>> r.get("user:1000")
b'gAAAAABcg8-LfQw9TeFZ1eXbi' # ... [truncated]
>>> cipher.decrypt(r.get("user:1000"))
b'{"cardnum": 2211849528391929, "exp": [2020, 9], "cv2": 842}'
>>> json.loads(cipher.decrypt(r.get("user:1000")))
{'cardnum': 2211849528391929, 'exp': [2020, 9], 'cv2': 842}
Because info
contains a value that is a list
, you’ll need to serialize this into a string that’s acceptable by Redis. (You could use json
, yaml
, or any other serialization for this.) Next, you encrypt and decrypt that string using the cipher
वस्तु। You need to deserialize the decrypted bytes using json.loads()
so that you can get the result back into the type of your initial input, a dict
।
नोट :Fernet uses AES 128 encryption in CBC mode. See the cryptography
docs for an example of using AES 256. Whatever you choose to do, use cryptography
, not pycrypto
(imported as Crypto
), which is no longer actively maintained.
If security is paramount, encrypting strings before they make their way across a network connection is never a bad idea.
Compression
One last quick optimization is compression. If bandwidth is a concern or you’re cost-conscious, you can implement a lossless compression and decompression scheme when you send and receive data from Redis. Here’s an example using the bzip2 compression algorithm, which in this extreme case cuts down on the number of bytes sent across the connection by a factor of over 2,000:
>>> 1>>> import bz2
2
3>>> blob = "i have a lot to talk about" * 10000
4>>> len(blob.encode("utf-8"))
5260000
6
7>>> # Set the compressed string as value
8>>> r.set("msg:500", bz2.compress(blob.encode("utf-8")))
9>>> r.get("msg:500")
10b'BZh91AY&SY\xdaM\x1eu\x01\x11o\x91\x80@\x002l\x87\' # ... [truncated]
11>>> len(r.get("msg:500"))
12122
13>>> 260_000 / 122 # Magnitude of savings
142131.1475409836066
15
16>>> # Get and decompress the value, then confirm it's equal to the original
17>>> rblob = bz2.decompress(r.get("msg:500")).decode("utf-8")
18>>> rblob == blob
19True
The way that serialization, encryption, and compression are related here is that they all occur client-side. You do some operation on the original object on the client-side that ends up making more efficient use of Redis once you send the string over to the server. The inverse operation then happens again on the client side when you request whatever it was that you sent to the server in the first place.
Using Hiredis
It’s common for a client library such as redis-py
to follow a protocol in how it is built. In this case, redis-py
implements the REdis Serialization Protocol, or RESP.
Part of fulfilling this protocol consists of converting some Python object in a raw bytestring, sending it to the Redis server, and parsing the response back into an intelligible Python object.
For example, the string response “OK” would come back as "+OK\r\n"
, while the integer response 1000 would come back as ":1000\r\n"
. This can get more complex with other data types such as RESP arrays.
A parser is a tool in the request-response cycle that interprets this raw response and crafts it into something recognizable to the client. redis-py
ships with its own parser class, PythonParser
, which does the parsing in pure Python. (See .read_response()
if you’re curious.)
However, there’s also a C library, Hiredis, that contains a fast parser that can offer significant speedups for some Redis commands such as LRANGE
. You can think of Hiredis as an optional accelerator that it doesn’t hurt to have around in niche cases.
All that you have to do to enable redis-py
to use the Hiredis parser is to install its Python bindings in the same environment as redis-py
:
$ python -m pip install hiredis
What you’re actually installing here is hiredis-py
, which is a Python wrapper for a portion of the hiredis
C library.
The nice thing is that you don’t really need to call hiredis
yourself. Just pip install
it, and this will let redis-py
see that it’s available and use its HiredisParser
instead of PythonParser
।
Internally, redis-py
will attempt to import hiredis
, and use a HiredisParser
class to match it, but will fall back to its PythonParser
instead, which may be slower in some cases:
# redis/utils.py
try:
import hiredis
HIREDIS_AVAILABLE = True
except ImportError:
HIREDIS_AVAILABLE = False
# redis/connection.py
if HIREDIS_AVAILABLE:
DefaultParser = HiredisParser
else:
DefaultParser = PythonParser
Using Enterprise Redis Applications
While Redis itself is open-source and free, several managed services have sprung up that offer a data store with Redis as the core and some additional features built on top of the open-source Redis server:
-
Amazon ElastiCache for Redis : This is a web service that lets you host a Redis server in the cloud, which you can connect to from an Amazon EC2 instance. For full setup instructions, you can walk through Amazon’s ElastiCache for Redis launch page.
-
Microsoft’s Azure Cache for Redis : This is another capable enterprise-grade service that lets you set up a customizable, secure Redis instance in the cloud.
The designs of the two have some commonalities. You typically specify a custom name for your cache, which is embedded as part of a DNS name, such as demo.abcdef.xz.0009.use1.cache.amazonaws.com
(AWS) or demo.redis.cache.windows.net
(Azure).
Once you’re set up, here are a few quick tips on how to connect.
From the command line, it’s largely the same as in our earlier examples, but you’ll need to specify a host with the h
flag rather than using the default localhost. For Amazon AWS , execute the following from your instance shell:
$ export REDIS_ENDPOINT="demo.abcdef.xz.0009.use1.cache.amazonaws.com"
$ redis-cli -h $REDIS_ENDPOINT
For Microsoft Azure , you can use a similar call. Azure Cache for Redis uses SSL (port 6380) by default rather than port 6379, allowing for encrypted communication to and from Redis, which can’t be said of TCP. All that you’ll need to supply in addition is a non-default port and access key:
$ export REDIS_ENDPOINT="demo.redis.cache.windows.net"
$ redis-cli -h $REDIS_ENDPOINT -p 6380 -a <primary-access-key>
The -h
flag specifies a host, which as you’ve seen is 127.0.0.1
(localhost) by default.
When you’re using redis-py
in Python, it’s always a good idea to keep sensitive variables out of Python scripts themselves, and to be careful about what read and write permissions you afford those files. The Python version would look like this:
>>> import os
>>> import redis
>>> # Specify a DNS endpoint instead of the default localhost
>>> os.environ["REDIS_ENDPOINT"]
'demo.abcdef.xz.0009.use1.cache.amazonaws.com'
>>> r = redis.Redis(host=os.environ["REDIS_ENDPOINT"])
यही सब है इसके लिए। Besides specifying a different host
, you can now call command-related methods such as r.get()
as normal.
नोट :If you want to use solely the combination of redis-py
and an AWS or Azure Redis instance, then you don’t really need to install and make Redis itself locally on your machine, since you don’t need either redis-cli
or redis-server
।
If you’re deploying a medium- to large-scale production application where Redis plays a key role, then going with AWS or Azure’s service solutions can be a scalable, cost-effective, and security-conscious way to operate.
Wrapping Up
That concludes our whirlwind tour of accessing Redis through Python, including installing and using the Redis REPL connected to a Redis server and using redis-py
in real-life examples. Here’s some of what you learned:
redis-py
lets you do (almost) everything that you can do with the Redis CLI through an intuitive Python API.- Mastering topics such as persistence, serialization, encryption, and compression lets you use Redis to its full potential.
- Redis transactions and pipelines are essential parts of the library in more complex situations.
- Enterprise-level Redis services can help you smoothly use Redis in production.
Redis has an extensive set of features, some of which we didn’t really get to cover here, including server-side Lua scripting, sharding, and master-slave replication. If you think that Redis is up your alley, then make sure to follow developments as it implements an updated protocol, RESP3.
Further Reading
Here are some resources that you can check out to learn more.
Books:
- Josiah Carlson: Redis in Action
- Karl Seguin: The Little Redis Book
- Luc Perkins et. al.: Seven Databases in Seven Weeks
Redis in use:
- Twitter: Real-Time Delivery Architecture at Twitter
- Spool: Redis bitmaps – Fast, easy, realtime metrics
- 3scale: Having fun with Redis Replication between Amazon and Rackspace
- Instagram: Storing hundreds of millions of simple key-value pairs in Redis
- Craigslist: Redis Sharding at Craigslist
- Disqus: Redis at Disqus
Other:
- Digital Ocean: How To Secure Your Redis Installation
- AWS: ElastiCache for Redis User Guide
- Microsoft: Azure Cache for Redis
- Cheatography: Redis Cheat Sheet
- ClassDojo: Better Rate Limiting With Redis Sorted Sets
- antirez (Salvatore Sanfilippo): Redis persistence demystified
- Martin Kleppmann: How to do distributed locking
- HighScalability: 11 Common Web Use Cases Solved in Redis