bitmap

Category: Bit structures
Wire type: bitmap
Construction: CREATE

Bit structures provide compact bit-level and integer-set storage.

Create a value

Use the top-level CREATE command to initialize this structured value. The example shows its construction options.

amaquet-cli -uri amaquet://127.0.0.1:13378 CREATE '{"key":"example:bitmap","type":"bitmap","options":{}}'

Construction options

Example CREATE options: {}. Omitted fields use server defaults.

Supported operations

SET, GETBIT, COUNT.

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:bitmap with the key used by your application.

Construction payloads

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

CREATE

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

{
  "key": "example:bitmap",
  "type": "bitmap",
  "options": {}
}

Operations

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

OP SET

Accepts unsigned bit, optional value:true and returns previous bit value; storage grows to the addressed 64-bit word.

{
  "key": "example:bitmap",
  "operation": "SET",
  "args": {
    "bit": 7,
    "value": true
  }
}

OP GETBIT

Accepts unsigned bit and returns boolean; out-of-range reads are false.

{
  "key": "example:bitmap",
  "operation": "GETBIT",
  "args": {
    "bit": 7
  }
}

OP COUNT

Takes no arguments and returns population count.

{
  "key": "example:bitmap",
  "operation": "COUNT",
  "args": {}
}

Top-level read payload

GET reads the current value without changing it:

{
  "key": "example:bitmap"
}

Key lifecycle payloads

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

• TYPE: {"key":"example:bitmap"} — returns the wire type.
• EXISTS: {"key":"example:bitmap"} — reports whether the key exists.
• EXPIRE: {"key":"example:bitmap","ttl_ms":5000} — assigns a five-second TTL.
• TTL: {"key":"example:bitmap"} — returns the remaining TTL in milliseconds.
• PERSIST: {"key":"example:bitmap"} — removes the TTL.
• DEL: {"keys":["example:bitmap"]} — 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.