ZteraDB Wire Protocol Specification

Reference Documentation: Request, Response, and Query Type Registries

This document specifies the official numeric opcodes used in the ZteraDB binary wire protocol. These constants facilitate connection negotiation, schema management, multi-tenant administrative routing, access control enforcement, and CRUD data execution patterns.

---

1. Request Types (Client-to-Server)

Request codes represent specific actions initiated by a client connection. OpCodes are structurally partitioned by their functional domains.

Connection & Basic Operations

Constant	Hex Value	Decimal	Description
NONE	0x0000	0	No operation / Placeholder state
CONNECT	0x0001	1	Initiates client session handshake
DISCONNECT	0x0002	2	Gracefully terminates client connection
QUERY	0x0005	5	Executes a data query command string
PING	0x0007	7	Session heartbeat check

Schema Management

Constant	Hex Value	Decimal	Description
CREATE_SCHEMA	0x0221	545	Registers a new structural schema
PUBLISH_SCHEMA	0x0222	546	Commits and freezes a schema version
SCHEMA	0x0223	547	Retrieves comprehensive schema metadata
SCHEMA_FIELDS	0x0224	548	Fetches field mapping attributes
SCHEMA_RELATED	0x0225	549	Resolves structural schema dependencies
SCHEMA_ACCESS	0x0226	550	Manages structural permission mappings

Database Administration

Constant	Hex Value	Decimal	Description
DATABASE	0x0227	551	Database instance cataloging request
ACTIVE_DATABASE	0x0228	552	Retrieves/mutates active session context
DATABASE_ACCESS	0x0229	553	Modifies database boundaries access controls

Identity & Access Management (IAM)

Constant	Hex Value	Decimal	Description
ENTERPRISE_USER	0x0230	560	Performs user account administration
ROLE	0x0231	561	RBAC configuration and mutation
ACCESS_CONTROL	0x0232	562	Granular system resource control lists
CREDENTIALS	0x0237	567	Rotates or alters cryptographic secret tokens
USER_PROFILE	0x0238	568	Fetches current user metadata constraints
MFA	0x0243	579	Multi-Factor authentication checks

Instance & Orchestration Nodes

Constant	Hex Value	Decimal	Description
ZTERADB_ENTERPRISE_INSTANCE_GROUP	0x0235	565	Orchestrates topology node groups
ENTERPRISE_INSTANCE	0x0236	566	Global topology configuration request

Logging, KPIs & System Utilities

Constant	Hex Value	Decimal	Description
ISSUE_TRACKER	0x0239	569	Registers or fetches diagnostic tracking bugs
ISSUE_TRACKER_COMMENT	0x0240	576	Appends comments to diagnostic issue tickets
ISSUE_TRACKER_CLUSTER	0x0241	577	Links issue records to multi-node clusters
DOWNLOAD_PACKAGE	0x0242	578	Requests platform binaries download payload
AUDITLOG	0x0244	580	Queries immutable compliance history logs
KPI	0x0245	581	Streams metric vectors for system instrumentation

---

2. Response Types (Server-to-Client)

Response codes classify operation success alongside network, authorization, or internal runtime failure boundaries.

Success Responses (2xx and lower)

Constant	Hex Value	Decimal	Description
NONE	0x0000	0	Null placeholder payload
CONNECTED	0x0002	2	Handshake successfully negotiated
QUERY_DATA	0x0007	7	Emits relational record data batch
PONG	0x0010	16	Responds directly to alive validation ping
CREATE_SCHEMA_SUCCESS	0x0201	513	Schema storage verified
PUBLISH_SCHEMA_SUCCESS	0x0202	514	Schema publication verified
QUERY_COMPLETE	0x0608	1544	All stream query outputs finished

Client-Side Error Responses (4xx series)

Constant	Hex Value	Decimal	Description
DISCONNECT	0x0400	1024	Connection closed by client-side event / Force disconnect
NO_ACCESS	0x0400	1024	Permission denied / RBAC security challenge rejected
TOKEN_EXPIRED	0x0401	1025	Session authorization / Token expired
QUERY_PARSE_ERROR	0x0420	1056	Malformed payload query block structure / Syntax error
INVALID_SCHEMA	0x0421	1057	Supplied schema structural validation failed
FIELD_ERROR	0x0422	1058	Out of bounds properties array mapping / Field error

Server-Side Error Responses (5xx series)

Constant	Hex Value	Decimal	Description
CONNECT_ERROR	0x0500	1280	Inbound system networking context exception
DISCONNECT_ERROR	0x0501	1281	Resource leak during clean session closing
CLIENT_AUTH_ERROR	0x0502	1282	Internal cryptographic parsing bottleneck
QUERY_ERROR	0x0520	1312	Engine database structural processing fault
CREATE_SCHEMA_ERROR	0x0521	1313	Storage subsystem write configuration drop
PUBLISH_SCHEMA_ERROR	0x0522	1314	Cluster replication synchronization failure

---

3. Query Mutation Types

When the client initiates a request type of QUERY (0x0005), the parsing framework evaluates the query block context header via the following internal operational parameters mapping to structural CRUD data state mutations:

Operation	Hex Value	Decimal Value	CRUD Mapping	Technical Behavior Description
INSERT	0x0001	1	CREATE	Inserts / Appends new data records into the schema
SELECT	0x0002	2	READ	Retrieves / Fetches filtered or complete data records from the schema
UPDATE	0x0003	3	UPDATE	Updates / Modifies existing data records within the schema
DELETE	0x0004	4	DELETE	Purges / Removes specific data records from the schema