BITFIELD

Performs arbitrary bitfield integer operations on strings.

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	BITFIELD
Catalog group	Bitmap commands
Upstream since	3.2.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

BITFIELD key [GET encoding offset | [OVERFLOW <WRAP | SAT | FAIL>]
  <SET encoding offset value | INCRBY encoding offset increment>
  [GET encoding offset | [OVERFLOW <WRAP | SAT | FAIL>]
  <SET encoding offset value | INCRBY encoding offset increment>
  ...]]

ffkv behavior and limits

Bitmap/bitfield values share string key storage. Bitfield overflow policy and signedness affect arithmetic; request and reply budgets still apply.

Source: README.md:275–280, 784–797; tests/bdd/features/bitmaps.feature.

All requests share the 8 MiB framing/1,024-argument ingress limit; normal RESP replies have 64 MiB wire/logical budgets with bounded nesting/value counts. Management and Lua origins impose smaller budgets. These are not a process RSS cap. Catalog inclusion is not exhaustive option or wire-format parity. See limits and compatibility.

Upstream metadata

The following fields come from the pinned Redis metadata, not measured ffkv performance or an assertion that ffkv enforces every upstream flag. Running COMMAND INFO/COMMAND DOCS describe the current engine.

Upstream Redis complexity: O(1) for each subcommand specified

Upstream arity: -2 (includes the command name; a negative number is a minimum).

Command flags: WRITE, DENYOOM.

ACL categories: BITMAP.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
operation	oneof	optional; multiple
↳ get-block	block	token: GET
↳ ↳ encoding	string	Required
↳ ↳ offset	integer	Required
↳ write	block	Required
↳ ↳ overflow-block	oneof	optional; token: OVERFLOW
↳ ↳ ↳ wrap	pure-token	token: WRAP
↳ ↳ ↳ sat	pure-token	token: SAT
↳ ↳ ↳ fail	pure-token	token: FAIL
↳ ↳ write-operation	oneof	Required
↳ ↳ ↳ set-block	block	token: SET
↳ ↳ ↳ ↳ encoding	string	Required
↳ ↳ ↳ ↳ offset	integer	Required
↳ ↳ ↳ ↳ value	integer	Required
↳ ↳ ↳ incrby-block	block	token: INCRBY
↳ ↳ ↳ ↳ encoding	string	Required
↳ ↳ ↳ ↳ offset	integer	Required
↳ ↳ ↳ ↳ increment	integer	Required

Key specifications

Upstream key discovery descriptors (indexes are relative to the full command vector):

[
  {
    "notes": "This command allows both access and modification of the key",
    "flags": [
      "RW",
      "UPDATE",
      "ACCESS",
      "VARIABLE_FLAGS"
    ],
    "begin_search": {
      "index": {
        "pos": 1
      }
    },
    "find_keys": {
      "range": {
        "lastkey": 0,
        "step": 1,
        "limit": 0
      }
    }
  }
]

Additional pinned upstream metadata

{
  "group": "bitmap",
  "since": "3.2.0"
}

Metadata source · Local snapshot: src/command_metadata.json, key bitfield.

BDD coverage and source examples

These are source observations, not a test run performed by this documentation build. A tag identifies scenario intent; an extracted vector identifies a command invocation, which may intentionally produce an error. Scenarios may require setup, multiple connections, persistence, cluster nodes or native-module fixtures.

• Bitfield overflow modes and read-only commands preserve values — tests/bdd/features/bitmaps.feature:167; command tag and invocation observed.
• BITOP AND applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:237; invocation observed.
• BITOP OR applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:261; invocation observed.
• BITOP XOR applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:285; invocation observed.
• BITOP DIFF applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:309; invocation observed.
• BITOP DIFF1 applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:333; invocation observed.
• BITOP ANDOR applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:357; invocation observed.
• BITOP ONE applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:381; invocation observed.
• NOT is unary and aliases use original source data — tests/bdd/features/bitmaps.feature:405; invocation observed.
• BITFIELD rejects non-string inputs without mutation — tests/bdd/features/bitmaps.feature:582; command tag and invocation observed.

Extracted command vectors

The following JSON arrays are the test harness’s argument vectors, not shell commands. Numeric arguments are converted by the harness; objects of the form {"base64":"…"} represent decoded binary bytes, not a literal JSON command argument. Preserve scenario setup and connection ordering. See the CLI guide for shell quoting and binary stdin. No reply is invented or inferred.

Bitfield overflow modes and read-only commands preserve values — tests/bdd/features/bitmaps.feature:169 (I execute:)

[
  "BITFIELD",
  "f",
  "SET",
  "u4",
  "6",
  "15",
  "GET",
  "u4",
  "6"
]

Next source assertion: the reply equals:

[0,15]

BITOP AND applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:239 (the following commands succeed:)

[
  "BITFIELD",
  "y",
  "SET",
  "u8",
  "0",
  "177"
]

BITOP OR applies zero padding and its full truth table — tests/bdd/features/bitmaps.feature:263 (the following commands succeed:)

[
  "BITFIELD",
  "z",
  "SET",
  "u8",
  "0",
  "144"
]