-
Notifications
You must be signed in to change notification settings - Fork 10
Document allowed Redis commands for FalkorDB Cloud #335
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.
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
base: main
Are you sure you want to change the base?
Changes from 5 commits
0224f49
1f2709e
f69101b
22068bb
9723c8e
40728da
85f24f8
fa5c7f2
d1407c1
a3a71e9
f47482f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -759,3 +759,11 @@ ORM | |
| orm | ||
| OGM | ||
| ogm | ||
| DBSIZE | ||
| PEXPIREAT | ||
| PTTL | ||
| EXPIRETIME | ||
| RENAMENX | ||
| WAITAOF | ||
| BGREWRITEAOF | ||
| Rebalancer | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| title: "Allowed Redis Commands" | ||
| nav_order: 10 | ||
| description: > | ||
| Redis commands available on FalkorDB Cloud | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @copilot Remove the word "Redis"
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed "Redis" from description. Commit: 85f24f8 |
||
| parent: "Cloud DBaaS" | ||
| --- | ||
|
|
||
| # Allowed Redis Commands | ||
|
|
||
| FalkorDB Cloud supports a subset of Redis commands as FalkorDB is built as a Redis module. This page documents the Redis commands that are available on FalkorDB Cloud. | ||
|
|
||
| ## Available Redis Commands | ||
|
|
||
| The following Redis commands are supported in FalkorDB: | ||
|
|
||
| ### Connection & Authentication | ||
| - **[AUTH](https://redis.io/commands/auth/)** - Authenticate to the server | ||
| - **[HELLO](https://redis.io/commands/hello/)** - Handshake with Redis server | ||
| - **[PING](https://redis.io/commands/ping/)** - Test connection to the server | ||
| - **[ECHO](https://redis.io/commands/echo/)** - Echo the given string | ||
|
|
||
| ### Server Information | ||
| - **[INFO](https://redis.io/commands/info/)** - Get information and statistics about the server | ||
| - **[CLIENT](https://redis.io/commands/client/)** - Manage client connections | ||
| - **[DBSIZE](https://redis.io/commands/dbsize/)** - Return the number of keys in the database | ||
| - **[MEMORY](https://redis.io/commands/memory/)** - Memory usage information | ||
| - **[SLOWLOG](https://redis.io/commands/slowlog/)** - Manage the slowlog | ||
|
|
||
| ### Key Management | ||
| - **[DEL](https://redis.io/commands/del/)** - Delete one or more keys | ||
| - **[DUMP](https://redis.io/commands/dump/)** - Return a serialized version of the value stored at the specified key | ||
| - **[EXISTS](https://redis.io/commands/exists/)** - Determine if a key exists | ||
| - **[EXPIRE](https://redis.io/commands/expire/)** - Set a key's time to live in seconds | ||
| - **[EXPIRETIME](https://redis.io/commands/expiretime/)** - Get the absolute Unix timestamp at which the key will expire | ||
| - **[PEXPIREAT](https://redis.io/commands/pexpireat/)** - Set the expiration for a key as a Unix timestamp specified in milliseconds | ||
| - **[PTTL](https://redis.io/commands/pttl/)** - Get the time to live for a key in milliseconds | ||
| - **[RENAME](https://redis.io/commands/rename/)** - Rename a key | ||
| - **[RENAMENX](https://redis.io/commands/renamenx/)** - Rename a key, only if the new key does not exist | ||
| - **[SCAN](https://redis.io/commands/scan/)** - Incrementally iterate over keys in the database | ||
| - **[TOUCH](https://redis.io/commands/touch/)** - Update the last access time of keys | ||
| - **[TTL](https://redis.io/commands/ttl/)** - Get the time to live for a key in seconds | ||
| - **[TYPE](https://redis.io/commands/type/)** - Determine the type stored at key | ||
| - **[UNLINK](https://redis.io/commands/unlink/)** - Delete a key asynchronously | ||
|
|
||
| ### Transaction Commands | ||
| - **[DISCARD](https://redis.io/commands/discard/)** - Discard all commands issued after MULTI | ||
| - **[EXEC](https://redis.io/commands/exec/)** - Execute all commands issued after MULTI | ||
| - **[MULTI](https://redis.io/commands/multi/)** - Mark the start of a transaction block | ||
| - **[UNWATCH](https://redis.io/commands/unwatch/)** - Forget about all watched keys | ||
| - **[WATCH](https://redis.io/commands/watch/)** - Watch keys for conditional execution of a transaction | ||
|
|
||
| ### Replication & Persistence | ||
| - **[WAIT](https://redis.io/commands/wait/)** - Wait for synchronous replication of writes | ||
| - **[WAITAOF](https://redis.io/commands/waitaof/)** - Wait for writes to be synchronized to AOF | ||
| - **[READONLY](https://redis.io/commands/readonly/)** ⚠️ - Enable read-only mode for a replica | ||
| - **[BGREWRITEAOF](https://redis.io/commands/bgrewriteaof/)** ⚠️ - Asynchronously rewrite the append-only file | ||
| - **[FLUSHALL](https://redis.io/commands/flushall/)** ⚠️ - Remove all keys from all databases | ||
|
|
||
| ### Module Management | ||
| - **[MODULE LIST](https://redis.io/commands/module-list/)** - List all loaded modules | ||
|
|
||
| ### FalkorDB Graph Commands | ||
| FalkorDB provides the following graph database commands: | ||
|
|
||
| - **GRAPH.BULK** - Bulk insert data into a graph (see [bulk loader specification](/design/bulk-spec)) | ||
| - **[GRAPH.CONFIG](/commands/graph.config-get)** - Get or set graph configuration parameters | ||
| - **[GRAPH.CONSTRAINT](/commands/graph.constraint-create)** - Manage graph constraints | ||
| - **[GRAPH.COPY](/commands/graph.copy)** - Copy a graph to a new key | ||
| - **[GRAPH.DELETE](/commands/graph.delete)** - Delete a graph | ||
| - **[GRAPH.EXPLAIN](/commands/graph.explain)** - Show the execution plan for a query | ||
| - **[GRAPH.INFO](/commands/graph.info)** - Get information about a graph | ||
| - **[GRAPH.LIST](/commands/graph.list)** - List all graphs | ||
| - **[GRAPH.MEMORY](/commands/graph.memory)** - Report memory usage of a graph | ||
| - **[GRAPH.PROFILE](/commands/graph.profile)** - Profile a query execution | ||
| - **[GRAPH.QUERY](/commands/graph.query)** - Execute a graph query | ||
| - **[GRAPH.RO_QUERY](/commands/graph.ro-query)** - Execute a read-only graph query | ||
| - **[GRAPH.SLOWLOG](/commands/graph.slowlog)** - Get the graph slowlog | ||
|
|
||
| ## Command Availability on FalkorDB Cloud | ||
|
|
||
| All Redis commands and FalkorDB graph commands listed above are available on FalkorDB Cloud. However, certain administrative commands have restrictions on the managed cloud service for security and stability reasons: | ||
|
|
||
| ### Commands with Cloud Restrictions | ||
|
|
||
| Commands marked with ⚠️ have the following restrictions: | ||
|
|
||
| - **READONLY** - This command is restricted as replication behavior is automatically managed by the cloud infrastructure | ||
| - **BGREWRITEAOF** - Background persistence operations are automatically managed by FalkorDB Cloud based on your tier | ||
| - **FLUSHALL** - Deleting all data across databases is restricted to prevent accidental data loss. Use `GRAPH.DELETE` to delete individual graphs instead | ||
|
|
||
| ### Cloud-Managed Features | ||
|
|
||
| On FalkorDB Cloud, the following features are automatically managed for you: | ||
|
|
||
| - **Persistence**: Automated backups are configured based on your tier (every 12 hours for Startup/Pro, every hour for Enterprise) | ||
| - **Replication**: High availability configurations automatically handle read replicas in Pro and Enterprise tiers | ||
| - **Security**: TLS encryption is enabled on Startup tier and above | ||
|
|
||
| For more information about FalkorDB Cloud tiers and features, see the [Cloud DBaaS overview](/cloud/). | ||
|
|
||
| ## See Also | ||
|
|
||
| - [FalkorDB Cloud](/cloud/) | ||
| - [Cloud Features](/cloud/features) | ||
| - [FalkorDB Commands Overview](/commands/) | ||
| - [Access Control Lists (ACL)](/commands/acl) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,11 @@ has_children: true | |
|
|
||
| FalkorDB exposes graph database functionality within Redis using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval. | ||
|
|
||
| ## Command Categories | ||
|
|
||
| * **[FalkorDB Graph Commands](#falkordb-api)** - Graph database operations (GRAPH.*) | ||
| * **[Cloud Redis Commands](/cloud/redis-commands)** - Redis commands available on FalkorDB Cloud | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @copilot remove this
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed. Commit: 40728da |
||
|
|
||
| ## FalkorDB API | ||
|
|
||
| Command details can be retrieved by filtering for the [module](/commands/?group=graph) or for a specific command, e.g., `GRAPH.QUERY`. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot Change to "Commands"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to "Commands". Commit: 85f24f8