Skip to content

Fix: Support unix socket connection to Redis #66

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

Open
sachinjogi wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fix: Support unix socket connection to Redis #66

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3b23f90
Fix: Support unix socket connection to Redis
sachinjogi Sep 23, 2024
e7204de
Merge branch 'main' into patch-1
sachinjogi Jan 2, 2025
312eba8
Merge branch 'main' into patch-1
gkorland Jun 20, 2025
de823f3
Merge branch 'main' into patch-1
gkorland Jun 21, 2025
3705fb2
Merge branch 'main' into patch-1
gkorland Dec 24, 2025
b8e6c18
Merge branch 'main' into patch-1
gkorland Feb 21, 2026
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
2 changes: 2 additions & 0 deletions falkordb/falkordb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ def from_url(cls, url: str, **kwargs) -> "FalkorDB":
kwargs["port"] = connection_kwargs.get("port", 6379)
kwargs["username"] = connection_kwargs.get("username")
kwargs["password"] = connection_kwargs.get("password")
kwargs["unix_socket_path"] = connection_kwargs.get("path")
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Suggest additional tests and documentation updates.

While the change correctly adds Unix socket support to the from_url method, consider the following suggestions to ensure comprehensive implementation:

  1. Add unit tests specifically for Unix socket connections using the from_url method.
  2. Update the class and method docstrings to mention Unix socket support.
  3. Consider adding an example of using a Unix socket connection in the class docstring.

Here's a suggested update for the class docstring:

class FalkorDB:
    """
    FalkorDB Class for interacting with a FalkorDB server.

    Supports both TCP and Unix socket connections.

    Usage examples::
        from falkordb import FalkorDB
        # Connect to the database using TCP and select the 'social' graph
        db = FalkorDB()
        graph = db.select_graph("social")

        # Connect using a Unix socket
        db_unix = FalkorDB.from_url("unix:///path/to/redis.sock")
        graph_unix = db_unix.select_graph("social")

        # Get a single 'Person' node from the graph and print its name
        result = graph.query("MATCH (n:Person) RETURN n LIMIT 1").result_set
        person = result[0][0]
        print(person.properties['name'])
    """

Also, consider adding a unit test for Unix socket connections:

def test_from_url_unix_socket():
    url = "unix:///path/to/redis.sock"
    db = FalkorDB.from_url(url)
    assert db.connection.connection_pool.connection_kwargs['unix_socket_path'] == "/path/to/redis.sock"
    assert db.connection.connection_pool.connection_kwargs['host'] is None
    assert db.connection.connection_pool.connection_kwargs['port'] is None

Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding test coverage for unix socket connections. The existing tests in tests/test_db.py::test_connect_via_url only cover TCP connections (falkor:// scheme). Adding a test case for unix:// URLs would help ensure this feature works correctly and prevent regressions.

Copilot uses AI. Check for mistakes.

Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing whitespace from this line.

Suggested change

Copilot uses AI. Check for mistakes.
if connection_class is redis.SSLConnection:
kwargs["ssl"] = True

Expand Down
Loading