Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add set and get examples #1916

Merged
merged 2 commits into from
Feb 6, 2022
Merged

Add set and get examples #1916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49cbfdb
Add set and get examples
dogukanteber Jan 30, 2022
1e42d87
Link the file to exapmles.rst
dogukanteber Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Examples
examples/connection_examples
examples/ssl_connection_examples
examples/search_json_examples
examples/set_and_get_examples
302 changes: 302 additions & 0 deletions docs/examples/set_and_get_examples.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,302 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "a3b456e8",
"metadata": {},
"source": [
"# Basic ```set``` and ```get``` operations"
]
},
{
"cell_type": "markdown",
"id": "a59abd54",
"metadata": {},
"source": [
"## Start off by connecting to the redis server\n",
"\n",
"To understand what ```decode_responses=True``` does, refer back to [this document](connection_examples.ipynb)"
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "97aa8747",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": 1,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"import redis \n",
"\n",
"r = redis.Redis(decode_responses=True)\n",
"r.ping()"
]
},
{
"cell_type": "markdown",
"id": "218e137f",
"metadata": {},
"source": [
"The most basic usage of ```set``` and ```get```"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "12992c68",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": 2,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.set(\"full_name\", \"john doe\")"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "bc9f3888",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"1"
]
},
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.exists(\"full_name\")"
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "dc64aec8",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"'john doe'"
]
},
"execution_count": 4,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.get(\"full_name\")"
]
},
{
"cell_type": "markdown",
"id": "353d334f",
"metadata": {},
"source": [
"We can override the existing value by calling ```set``` method for the same key"
]
},
{
"cell_type": "code",
"execution_count": 5,
"id": "c61389ce",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": 5,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.set(\"full_name\", \"overridee!\")"
]
},
{
"cell_type": "code",
"execution_count": 6,
"id": "5e34a520",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"'overridee!'"
]
},
"execution_count": 6,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.get(\"full_name\")"
]
},
{
"cell_type": "markdown",
"id": "4ae3747b",
"metadata": {},
"source": [
"It is also possible to pass an expiration value to the key by using ```setex``` method"
]
},
{
"cell_type": "code",
"execution_count": 7,
"id": "9b87449b",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": 7,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.setex(\"important_key\", 100, \"important_value\")"
]
},
{
"cell_type": "code",
"execution_count": 8,
"id": "a11fe79d",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"100"
]
},
"execution_count": 8,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.ttl(\"important_key\")"
]
},
{
"cell_type": "markdown",
"id": "87c16991",
"metadata": {},
"source": [
"A dictionary can be inserted like this"
]
},
{
"cell_type": "code",
"execution_count": 9,
"id": "3cfa5713",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"True"
]
},
"execution_count": 9,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"dict_data = {\n",
" \"employee_name\": \"Adam Adams\",\n",
" \"employee_age\": 30,\n",
" \"position\": \"Software Engineer\",\n",
"}\n",
"\n",
"r.mset(dict_data)"
]
},
{
"cell_type": "markdown",
"id": "6d32dbee",
"metadata": {},
"source": [
"To get multiple keys' values, we can use mget. If a non-existing key is also passed, Redis return None for that key"
]
},
{
"cell_type": "code",
"execution_count": 10,
"id": "45ce1231",
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"['Adam Adams', '30', 'Software Engineer', None]"
]
},
"execution_count": 10,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"r.mget(\"employee_name\", \"employee_age\", \"position\", \"non_existing\")"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.5"
}
},
"nbformat": 4,
"nbformat_minor": 5
}