# Создание потока

Создание нового потока с указанной конфигурацией.

<!-- -->

## Тема

`$JS.API.STREAM.CREATE.{stream}`

Где `{stream}` — имя создаваемого потока.

## Запрос

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

Развернуть всё

Все следующие варианты:

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`

pedanticboolean

Включает строгий режим, в котором сервер не подставляет значения по умолчанию и не изменяет запрос

По умолчанию:`false`

## Ответ

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

Развернуть всё

Один из следующих вариантов:

Вариант

<!-- -->

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\_create\_response"обязательно

did\_createboolean

Указывает, создан ли поток заново, а не найден существующий с совпадающей конфигурацией
