Block Quick Reference

The 50 blocks that cover 95% of daily work: what each does, and where to read more. Use ⌘K to search this table.

Pages & UI

Block	Does what
`state_page`	Registers a page URL and starts the page flow.
`state_render_page`	Sends the assembled HTML to the browser.
`state_h1` / text elements	Headings, text, containers on the page.
`state_form`	Form container element.
`state_input_dynamic`	Typed input field inside a form.
`state_button`	Button with a click event.
`state_form_get`	Reads the submitted form (`form-object`, `form-error`).
`state_advanced_datatable`	Pre-styled table fed from a storage.

APIs & HTTP

Block	Does what
`on_startup_register_uri_get`	Registers `GET /api/v1/<uri>`.
`on_startup_register_uri_post`	Registers `POST /api/v1/<uri>` (webhooks, creates).
`httpconnection_current_request`	The live request connection object.
`httpconnection_get_params`	Reads query parameters of the current request.
`httpconnection_set_json`	Replies to the caller with JSON + status code.
`http request` (http connection group)	Calls external APIs.

Storage & Queries

Block	Does what
`storage`	Selects the storage collection for connected blocks.
`function_search`	Searches documents (query, limit, offset, cache key).
`function_search_single_result`	Searches and returns the first hit only.
`function_get_document`	Reads one document by guid.
`function_create_document_from_mutations`	Creates a document from a mutation set.
`function_update_document_mutations`	Applies mutations to an existing document.
`function_remove_document` / `function_delete_document`	Soft-deletes (recoverable) / hard-deletes.
`mutations_set_bp_field_multiple`	Sets several document fields at once.
`mutations_set_custom_field`	Sets one field with a custom value.
`mutations_increment_by_field`	Atomically increments/decrements a number.
`query_and` / `query_bool_must`	Combines query parts (AND / multi-term OR).
`query_bool_term_fields`	Exact match on one field.
`query_bool_filter`	Attaches filter clauses.
`query_bool_simple_query_string_field`	Free-text match on a field.
`query_bool_range_field`	Date/number range on a field.
`query_sort_field`	Sorts results by a field.

Data & Logic

Block	Does what
`value_default` / `number_default`	A fixed text / number value.
`object_new_fields`	Builds an object with named fields.
`object_update_fields`	Adds/changes fields on an existing object.
`array_map`	Transforms every item in an array.
`branch`	Splits flow into true/false paths on a condition.
`condition_not_empty_value`	True when the checked value is filled.
`function_console_log`	Writes to the blueprint console.
`trigger_custom_function`	Defines/calls a reusable function.
`function_return`	Returns values from a function.

Background & Scheduling

Block	Does what
`function_custom_execute_from_queue`	Defers work to the queue (heavy jobs, retries).
`schedule_repeating_event`	Fires a flow on a schedule.
`storage_event`	Fires on document create/update/save/remove.
`function_redis_cache_delete_key`	Deletes a Redis cache key (invalidation).
`user_current`	The calling user's document.

Next Steps

All Blocks The full 1,600+ block library by group. Block Templates These blocks wired into working combinations. Finding Blocks Search techniques and starter sets.

Frequently asked

What are the most-used blocks in RUAL?

This page lists the 50 blocks that cover 95% of daily work, grouped into Pages and UI, APIs and HTTP, Storage and Queries, Data and Logic, and Background and Scheduling. Each entry links to the block's full documentation, and you can search the table with ⌘K.

Which RUAL block registers a GET endpoint?

on_startup_register_uri_get registers GET /api/v1/<uri>. The POST variant on_startup_register_uri_post is used for webhooks and creates, and httpconnection_set_json replies to the caller with JSON plus a status code.

What is the difference between function_remove_document and function_delete_document in RUAL?

function_remove_document soft-deletes a document, which stays recoverable, while function_delete_document hard-deletes it.