Перейти к основному содержимому
Версия: 2.15 (последняя)

Обновление потока

Обновление конфигурации существующего потока.

Тема​

$JS.API.STREAM.UPDATE.{stream}

Где {stream} — имя обновляемого потока.

Запрос​

Запрос к API JetStream $JS.API.STREAM.UPDATE

Все следующие варианты:
namestring
Уникальное имя потока; для шаблонов потоков — пустая строка.
Шаблон:^[^.*>]*$
Минимальная длина:0
descriptionstring
Краткое описание назначения потока
Максимальная длина:4096
subjectsstring[]
Список тем для чтения с поддержкой подстановочных символов. Должен быть пустым при настроенном зеркале; при настроенных источниках может быть пустым.
Минимальная длина:0
subject_transformobject
Преобразование темы подходящих сообщений
retentionstringобязательно
Правила хранения сообщений потока; после превышения ограничений старые сообщения удаляются.
Допустимые значения:
limitsХранить сообщения до удаления по ограничениям потока (max_msgs, max_bytes или max_age).interestУдалять сообщение после подтверждения всеми потребителями с подходящим фильтром; при отсутствии подходящего потребителя сообщение сразу отбрасывается.workqueueУдалять сообщение после подтверждения одним потребителем; фильтры тем потребителей не должны пересекаться.
По умолчанию:limits
max_consumersintegerобязательно
Максимальное число потребителей потока. -1 отключает ограничение.
Целое число с разрядностью, зависящей от платформы кластера, до 64 бит
Минимум:-1
Максимум:9223372036854776000
По умолчанию:-1
max_msgsintegerобязательно
Максимальное число сообщений потока; при превышении удаляются самые старые. -1 отключает ограничение.
Знаковое 64-битное целое число
Минимум:-1
Максимум:9223372036854776000
По умолчанию:-1
max_msgs_per_subjectinteger
Для потоков с шаблоном темы сохраняет указанное число сообщений для каждой уникальной темы — лимит хранения на тему
Знаковое 64-битное целое число
Минимум:-1
Максимум:9223372036854776000
По умолчанию:-1
max_bytesintegerобязательно
Максимальный суммарный размер потока; при превышении удаляются старые сообщения. -1 отключает ограничение.
Знаковое 64-битное целое число
Минимум:-1
Максимум:9223372036854776000
По умолчанию:-1
max_ageintegerобязательно
Максимальный возраст сообщения потока в наносекундах. 0 отключает ограничение.
Длительность в наносекундах, знаковое 64-битное целое число
Минимум:0
Максимум:9223372036854776000
По умолчанию:0
max_msg_sizeinteger
Максимальный размер сообщения, принимаемого потоком. -1 отключает ограничение.
Знаковое 32-битное целое число
Минимум:-1
Максимум:2147483647
По умолчанию:-1
storagestringобязательно
Механизм хранения потока.
Допустимые значения:
fileХранить данные потока на диске.memoryХранить данные потока только в памяти: они не переживают перезапуск сервера.
По умолчанию:file
compressionstring
Необязательный алгоритм сжатия потока.
Допустимые значения:
noneХранить блоки сообщений без сжатия.s2Сжимать хранимые блоки сообщений алгоритмом S2, расширением Snappy.
По умолчанию:none
first_seqinteger
Начальный порядковый номер первого сообщения потока
Беззнаковое 64-битное целое число
Минимум:0
Максимум:18446744073709552000
num_replicasintegerобязательно
Число реплик каждого сообщения.
Целое число с разрядностью, зависящей от платформы кластера, до 64 бит
Минимум:0
Максимум:5
По умолчанию:1
no_ackboolean
Отключает подтверждение получаемых потоком сообщений.
По умолчанию:false
discardstring
При достижении лимитов потока старые сообщения удаляются либо новые отклоняются
Допустимые значения:
oldПри достижении лимита удалять самые старые сообщения, освобождая место для новых.newОтклонять новые сообщения, пока поток достиг своего лимита.
По умолчанию:old
duplicate_windowinteger
Окно отслеживания дубликатов в наносекундах. 0 выбирает значение по умолчанию
Длительность в наносекундах, знаковое 64-битное целое число
Минимум:0
Максимум:9223372036854776000
По умолчанию:0
placementobject
Правила размещения реплик потока; если не заданы, размещение случайно
mirrorobject
Поддерживает точное зеркало другого потока с именем из этого свойства. При настроенном зеркале subjects и sources должны быть пустыми.
sourcesobject[]
Список имён потоков, реплицируемых в этот поток
sealedboolean
Запечатанные потоки не допускают удаления сообщений по лимитам и через API; снять запечатывание обновлением конфигурации нельзя. Параметр задаётся только существующему потоку через Update API
По умолчанию:false
deny_deleteboolean
Запрещает удалять сообщения потока через API. После установки true изменить нельзя
По умолчанию:false
deny_purgeboolean
Запрещает очищать сообщения потока через API. После установки true изменить нельзя
По умолчанию:false
allow_rollup_hdrsboolean
Разрешает заголовок Nats-Rollup для замены всего содержимого потока или одной его темы единственным новым сообщением
По умолчанию:false
allow_directboolean
Разрешить высокопроизводительное прямое получение отдельных сообщений
По умолчанию:false
allow_atomicboolean
Разрешить атомарную пакетную публикацию
По умолчанию:false
allow_msg_counterboolean
Настраивает поток как счётчик с отклонением всех остальных сообщений
По умолчанию:false
allow_msg_schedulesboolean
Разрешает отправку сообщений по расписанию
По умолчанию:false
mirror_directboolean
Разрешить высокопроизводительный прямой доступ также для зеркал
По умолчанию:false
republishobject
Правила повторной публикации из потока с преобразованием тем для секционирования и других задач
discard_new_per_subjectboolean
При политике отбрасывания new и лимите сообщений на тему новое поведение применяется отдельно к каждой теме. Таким образом discard new ограничивает число сообщений темы, а не число тем.
По умолчанию:false
metadata{ [key: string]: string }
Дополнительные метаданные потока
consumer_limitsobject
Ограничения отдельных параметров потребителей; значения по умолчанию для не задавших их потребителей
allow_msg_ttlboolean
Включает TTL отдельных сообщений через заголовки
По умолчанию:false
subject_delete_marker_ttlinteger
Включает и задаёт срок хранения серверных маркеров удаления, очистки и достижения максимального возраста
Длительность в наносекундах, знаковое 64-битное целое число
Минимум:0
Максимум:9223372036854776000
persist_modestring
Задаёт режим долговременной записи в поток
Допустимые значения:
""Не задано: сервер использует режим по умолчанию.defaultЗаписи сбрасываются в хранилище до подтверждения публикации.asyncЗаписи сбрасываются в фоне: публикация может быть подтверждена до сохранения сообщения.
По умолчанию:
allow_batchedboolean
Разрешает быструю пакетную публикацию в поток
По умолчанию:false

Ответ​

Ответ API JetStream $JS.API.STREAM.UPDATE

Один из следующих вариантов:
Вариант 1 (object)
configobjectобязательно
Действующая конфигурация потока
stateobjectобязательно
Подробности текущего состояния потока
createdstring<date-time>обязательно
Временная метка создания потока
Момент времени в формате RFC3339 с часовым поясом, обычно UTC
tsstring<date-time>
Серверное время формирования информации о потоке
Момент времени в формате RFC3339 с часовым поясом, обычно UTC
clusterobject
mirrorobject
Информация о вышестоящем потоке-источнике зеркала
sourcesobject[]
Потоки-источники этого потока
alternatesobject[]
Список зеркал в порядке приоритета
domainstring
Домен JetStream, содержащий поток
Вариант 2 (object)
errorobjectобязательно
typeconst: "io.nats.jetstream.api.v1.stream_update_response"обязательно