Skip to main content

Sync/Async Bridge

Ryx is async-native, but provides helpers for use in synchronous environments.

run_sync​

Run an async ORM query from sync code:

from ryx import run_sync

posts = run_sync(Post.objects.filter(active=True))
post  = run_sync(Post.objects.get(pk=1))
count = run_sync(Post.objects.count())

This creates a temporary event loop, runs the query, and returns the result.

sync_to_async​

Wrap a blocking function for use in async code:

from ryx import sync_to_async

@sync_to_async
def read_file(path):
    with open(path) as f:
        return f.read()

content = await read_file("data.txt")

async_to_sync​

Wrap an async function for sync callers:

from ryx import async_to_sync

get_post = async_to_sync(Post.objects.get)
post = get_post(pk=42)

run_async​

Run a sync function in a thread pool from async code:

from ryx import run_async

result = await run_async(some_blocking_library.call, arg1, arg2)

When to Use​

ScenarioHelper
Sync script using Ryxrun_sync()
Async code calling blocking I/Osync_to_async()
Sync code calling async Ryxasync_to_sync()
Async code calling blocking CPU workrun_async()

Next Steps​

→ Raw SQL — Escape hatch for complex queries