Skip to content

url

Category: Graph, synchronization, and network
Wire type: url
Construction: SET

These types cover graph adjacency, atomic coordination, synchronization, rate limiting, and network values.

Use the top-level SET command to store this directly encoded value. The example shows the required wire representation.

Terminal window
amaquet-cli -uri amaquet://127.0.0.1:13378 SET '{"key":"example:url","type":"url","value":"https://example.com:8443/path?q=amaquet"}'

This type is constructed with SET; it has no CREATE options.

HOST, SCHEME.

See the complete operation contract for exact arguments, defaults, results, and whether a listed GET is the top-level key command or a type-specific OP. It also identifies read-only operations and documents validation, lazy maintenance, and key-version behavior.

The following examples use the public amaquet-cli JSON command format. Replace example:url with the key used by your application.

Use the payload below to initialize this type before issuing reads or type-specific operations.

This payload initializes the value and must complete before its type-specific operations are used.

{
"key": "example:url",
"type": "url",
"value": "https://example.com:8443/path?q=amaquet"
}

Each request uses the OP envelope. The response is the type-specific value described in the complete operation contract.

Takes no arguments and returns parsed host or scheme string.

{
"key": "example:url",
"operation": "HOST",
"args": {}
}

Takes no arguments and returns parsed host or scheme string.

{
"key": "example:url",
"operation": "SCHEME",
"args": {}
}

GET reads the current value without changing it:

{
"key": "example:url"
}

These commands apply to the key regardless of its registered type:

  • TYPE: {"key":"example:url"} — returns the wire type.
  • EXISTS: {"key":"example:url"} — reports whether the key exists.
  • EXPIRE: {"key":"example:url","ttl_ms":5000} — assigns a five-second TTL.
  • TTL: {"key":"example:url"} — returns the remaining TTL in milliseconds.
  • PERSIST: {"key":"example:url"} — removes the TTL.
  • DEL: {"keys":["example:url"]} — deletes the key.

For defaults, validation, result shapes, and persistence classification, see the complete operation contract.

The key participates in TYPE, EXISTS, TTL, EXPIRE, PERSIST, and DEL. Top-level GET returns the type’s direct public value or a synchronized snapshot.