c55d3080cf
CI / test (push) Has been cancelled
CI / verify (push) Has been cancelled
Clients CI / build-server (push) Has been cancelled
Clients CI / test-python (push) Has been cancelled
Clients CI / test-javascript (push) Has been cancelled
Clients CI / test-nim (push) Has been cancelled
Clients CI / test-rust (push) Has been cancelled
Documentation updates: - Fix v0.1.0 → v1.1.0 version numbers in en, ru, fa, zh docs - Add missing Window Functions, Multi-Tenant ERP, Supported Keywords sections to ru, fa, zh baraql.md (~105 lines each) - Expand Turkish and Arabic baraql.md (110 → 268 lines) - Expand Turkish and Arabic installation.md (62 → 307 lines) - Add new Bulgarian documentation files (18 new files) Client updates: - Python: Full async/await rewrite with asyncio, request queueing - Rust: Full async/await rewrite with tokio, async examples - Nim: Update README to v1.1.0 - All clients now support async patterns consistently
2.6 KiB
2.6 KiB
API за Бинарен Протокол
Ниско-нивов wire протокол за високопроизводителни клиентски връзки.
Формат на Съобщенията
Всички съобщения използват big-endian byte order:
┌─────────────┬─────────────┬─────────────┬─────────────────────┐
│ Kind │ Length │ RequestId │ Payload │
│ (4 bytes) │ (4 bytes) │ (4 bytes) │ │
│ uint32 BE │ uint32 BE │ uint32 BE │ (Length bytes) │
└─────────────┴─────────────┴─────────────┴─────────────────────┘
Типове Съобщения
Query (0x01)
let msg = makeQueryMessage(requestId, "SELECT * FROM users")
QueryParams (0x02)
let msg = makeQueryParamsMessage(requestId, "SELECT * FROM users WHERE name = ?", params)
Auth (0x07)
let msg = makeAuthMessage(requestId, token)
Ping (0x09)
let msg = makePingMessage(requestId)
Close (0x0A)
let msg = makeCloseMessage(requestId)
Отговорни Съобщения
Ready (0x05)
let msg = makeReadyMessage(requestId)
Error (0x06)
let msg = makeErrorMessage(requestId, code, message)
Data (0x81)
# Съдържа резултатите от заявката с колони и редове
Complete (0x82)
# Потвърждава завършване на заявката
Auth_OK (0x83)
# Потвърждава успешна автентикация
Pong (0x84)
# Keepalive отговор
Кодове за Грешки
| Код | Име | Описание |
|---|---|---|
| 0x00 | OK | Успех |
| 0x01 | ERROR | Обща грешка |
| 0x02 | AUTH_REQUIRED | Изисква се автентикация |
| 0x03 | INVALID_QUERY | Синтактична грешка в заявката |
| 0x04 | NOT_FOUND | Ресурсът не е намерен |
Сериализация
import barabadb/protocol/wire
# Сериализиране на стойност
let bytes = serializeValue(Value(kind: vkString, strVal: "test"))
# Десериализиране на стойност
let value = deserializeValue(bytes)