SolrClient::addDocument — Добавляет документ в индекс

Назначение SolrClient::addDocument

SolrClient::addDocument: Добавляет документ в индекс. Справочная сущность относится к разделу «solr». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается SolrClient::addDocument

Эта страница описывает член addDocument класса SolrClient, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $doc; необязательные $overwrite, $commitWithin; объявленный результат — SolrUpdateResponse.

Смысловое направление SolrClient::addDocument

Смысловое направление SolrClient::addDocument — «изменение состояния». В прикладном коде до вызова сохраните ожидаемое исходное состояние, после — проверьте фактическое изменение. Контрольный набор для этой операции: проверьте идемпотентность повтора и конфликт параллельного обновления. Такой акцент отделяет SolrClient::addDocument от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура SolrClient::addDocument

Структурная запись: public SolrUpdateResponse SolrClient::addDocument(SolrInputDocument $doc, bool $overwrite = true, int $commitWithin = 0). В ней 3 параметра: обязательные $doc; необязательные $overwrite, $commitWithin. Результат объявлен как SolrUpdateResponse; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры SolrClient::addDocument

Порядок и роли аргументов по сигнатуре: 1. $doc — SolrInputDocument, обязателен; 2. $overwrite — bool, необязателен, default true; 3. $commitWithin — int, необязателен, default 0.

Контроль входных данных для SolrClient::addDocument

1) SolrInputDocument $doc — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 2) bool $overwrite — необязательный: передайте true и false явно, не полагаясь на нестрогое приведение скалярных значений. 3) int $commitWithin — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки.

Результат SolrClient::addDocument

SolrClient::addDocument объявляет результат типа SolrUpdateResponse. Результат SolrClient::addDocument имеет объявленный тип SolrUpdateResponse. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

Проверочный сценарий для SolrClient::addDocument

Подготовьте объект SolrClient в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором SolrInputDocument $doc. Затем отдельно добавьте необязательные параметры bool $overwrite=true, int $commitWithin=0, чтобы увидеть влияние значений по умолчанию. Для профиля «контракт PHP» важно зафиксировать предусловия вызова и не подавлять диагностические сообщения; негативный сценарий должен проверить штатный результат, граничный вход и документированный отказ.

Интеграция SolrClient::addDocument в проект

Храните подготовку SolrClient и вызов SolrClient::addDocument в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «контракт PHP» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция SolrClient::addDocument не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика SolrClient::addDocument

Сначала запишите точную сигнатуру public SolrUpdateResponse SolrClient::addDocument(SolrInputDocument $doc, bool $overwrite = true, int $commitWithin = 0) и фактические типы переданных значений. Затем проверьте состояние экземпляра SolrClient непосредственно перед методом SolrClient::addDocument. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «контракт PHP» применяйте отдельный негативный тест: проверить штатный результат, граничный вход и документированный отказ. В production-коде важно зафиксировать предусловия вызова и не подавлять диагностические сообщения. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать SolrClient::addDocument

Выбор SolrClient::addDocument оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к SolrClient; 2) сигнатура содержит 3 аргумента: обязательных 1, необязательных 2; 3) вызывающему коду нужен результат SolrUpdateResponse и действие «изменение состояния». Для профиля «контракт PHP» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с SolrClient::addDocuments: у него другое назначение, владелец или набор входных данных.

Сравнение SolrClient::addDocument с соседними API

Для SolrClient::addDocument базовый ориентир: добавляет документ в индекс; обязательные $doc; необязательные $overwrite, $commitWithin; результат SolrUpdateResponse. Сопоставление с опубликованными соседями: SolrClient::addDocuments: добавляет коллекцию экземпляров solrinputdocument в индекс; вход — обязательные $docs; необязательные $overwrite, $commitWithin; результат — void. SolrClient::commit: завершает каждое добавление и удаление, которое сделали в индексе; вход — необязательные $softCommit, $waitSearcher, $expungeDeletes; результат — SolrUpdateResponse. SolrInputDocument::addChildDocument: добавляет дочерний документ для блочной индексации; вход — обязательные $child; результат — void. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

SolrClient::addDocument сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для SolrClient::addDocument.

Связанные материалы