polygon

Category: Geospatial
Wire type: polygon
Construction: SET

Geospatial types use latitude/longitude coordinates and spatial predicates.

Create a value

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

amaquet-cli -uri amaquet://127.0.0.1:13378 SET '{"key":"example:polygon","type":"polygon","value":[{"Lat":14.5,"Lon":120.9},{"Lat":14.7,"Lon":120.9},{"Lat":14.6,"Lon":121.1}]}'

Construction options

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

Supported operations

CONTAINS.

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.

Operation payloads

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

Construction payloads

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

SET

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

{
  "key": "example:polygon",
  "type": "polygon",
  "value": [
    {
      "Lat": 14.5,
      "Lon": 120.9
    },
    {
      "Lat": 14.7,
      "Lon": 120.9
    },
    {
      "Lat": 14.6,
      "Lon": 121.1
    }
  ]
}

Operations

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

OP CONTAINS

Accepts point:{lat,lon} and returns boolean containment; polygon uses ray casting on lon/lat coordinates.

{
  "key": "example:polygon",
  "operation": "CONTAINS",
  "args": {
    "point": {
      "Lat": 14.6,
      "Lon": 121.0
    }
  }
}

Top-level read payload

GET reads the current value without changing it:

{
  "key": "example:polygon"
}

Key lifecycle payloads

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

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

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

Key lifecycle

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.