ExecuteCypher

gRPC · Database service

SERVER STREAM

Execute a Cypher statement and receive typed result rows. Bind parameters through the request map.

/shrikedb.v2.ShrikeDbService/ExecuteCypher
RequestCypherQueryRequest
Stream of responsesQueryResultRow

Request fields

Protocol fieldTypeJSON field
querystringquery
snapshot_versionuint64snapshotVersion
limituint32limit
offsetuint32offset
parametersmap<string, Value>parameters

Response contract

Open QueryResultRow for every field, enum, nested message, and presence rule. Consume the stream until its final status. A failed stream can contain earlier rows that are not a complete answer.

Connection and availability

Use the selected database and caller credentials from your deployment. Feature settings, permissions, snapshot support, and HA restrictions govern whether an operation can execute. See authentication and wire encoding for metadata, deadlines, and retry behavior.

Governed Cypher mutations use SHRIKEDB_CYPHER_WRITE_MODE=canary or full and tenant Write permission. The write example and language guide identify supported statement shapes.

Read the language guide for the supported mutation forms and deployment settings.