Система для сравнительного анализа Lucene:

• Lucene.Net.Classification — модуль классификации для Lucene;
• Lucene.Net.Codecs — кодеки и форматы публикаций Lucene;
• Lucene.Net.Expressions — динамически вычисляемые значения для сортировки, фасетирования и поиска на основе подключаемой грамматики;
• Lucene.Net.Facet — возможности фасетного индексирования и поиска;
• Lucene.Net.Grouping — сборщики для группировки результатов поиска;
• Lucene.Net.Highlighter — выделяет ключевые слова поиска в результатах;
• Lucene.Net.ICU — специализированные анализаторы и средства выделения ICU (International Components for Unicode);
• Lucene.Net.Join — объединение на уровне индекса и запросов для нормализованного контента;
• Lucene.Net.Memory — реализация однодокументного индекса в памяти;
• Lucene.Net.Misc — инструменты индексирования и другой вспомогательный код;
• Lucene.Net.Queries — фильтры и запросы, которые дополняют основной Lucene;
• Lucene.Net.QueryParser — парсеры текста в запрос и структура парсинга;
• Lucene.Net.Replicator — утилита репликации файлов;
• Lucene.Net.Sandbox — различные сторонние вклады и новые идеи;
• Lucene.Net.Spatial — геопространственный поиск;
• Lucene.Net.Suggest — автоподсказка и поддержка проверки орфографии;
• Lucene.Net.TestFramework — фреймворк для тестирования приложений на базе Lucene.

Документация

У нас есть предварительная документация для Lucene.NET 4.8.0 на веб-сайте Lucene.NET. API похож на Java Lucene 4.8.0, который также может быть полезен для ознакомления.

Примечание: мы работаем над исправлением проблем с документацией, но могли бы использовать дополнительную помощь, поскольку это масштабный проект. См. #206.

Версии наследия

• Документация по API Lucene.Net 3.0.3: http://incubator.apache.org/lucene.net/docs/3.0.3/Index.html;
• Документация по API Lucene.Net 2.9.4: http://incubator.apache.org/lucene.net/docs/2.9.4/Index.html.

Демоверсии и инструменты

Есть несколько демонстрационных версий, реализованных в виде простых консольных приложений, которые можно скопировать и вставить в Visual Studio или скомпилировать в командной строке в проекте Lucene.Net.Demo.

Также доступен инструмент командной строки dotnet на NuGet. Он содержит все демонстрации, а также инструменты для обслуживания вашего индекса Lucene.NET, включая такие операции, как разделение, слияние, перечисление информации о сегментах, исправление, удаление сегментов, обновление и т. д. Всегда делайте резервную копию своего индекса перед выполнением любых команд!

Предварительное условие: среда выполнения .NET 8.0 или выше.

dotnet tool install lucene-cli -g --version 4.8.0-beta00015

Примечание: версия CLI, которую вы устанавливаете, должна соответствовать версии Lucene.NET, которую вы используете.

После установки вы можете изучить доступные команды и параметры, введя команду lucene.

Документация по lucene-CLI: https://github.com/apache/lucenenet/blob/master/src/dotnet/tools/lucene-cli/docs/index.md.

Как внести свой вклад

Мы рады получать вклады! Прочитайте наше руководство по вкладам или продолжайте читать о том, чем вы можете помочь.

Присоединяйтесь к спискам рассылки Версия пакета NuGet. Если не указано, будет использоваться версия из файла Version.proj.

build –pv 4.8.0–beta00001

Версия пакета NuGet.

Версия теста. Запускает тесты после сборки. Этот параметр не требует значения. Обратите внимание, что тестирование обычно занимает около 40 минут с 8 параллельными заданиями.

build –t

Запуск тестов.

Файл версии. Версия сборки файла. Если не указано, по умолчанию используется значение параметра –package-version (исключая любую предварительную метку выпуска). Версия сборки будет получена из основного компонента переданной версии, исключая компоненты minor, build и revision.

build —pv 4.8.0–beta00001 —fv 4.8.0

Пример команды для создания сборки Release с версией пакета NuGet 4.8.0-ci00015 и версией файла 4.8.0.

Например, в приведённой ниже команде создаётся сборка Release с версией пакета NuGet 4.8.0-ci00015 и версией файла 4.8.0. Версия сборки будет получена из основного компонента переданного значения, исключая минорные, билдовые и ревизионные компоненты (в данном случае 4.0.0).

Windows

> build ––configuration Release –pv 4.8.0–ci00015 –fv 4.8.0

Linux или macOS

./build ––configuration Release –pv 4.8.0–ci00015 –fv 4.8.0

В приведённом выше примере мы используем «ci» в версии пакета, чтобы указать, что это не публично выпущенная бета-версия, а скорее результат непрерывной интеграции сборки из master, которая произошла после beta00014, но до того, как была выпущена beta00015. Пакеты NuGet выводятся сборкой в каталог /_artifacts/NuGetPackages/. Результаты тестирования (если применимо) выводятся в каталог /_artifacts/TestResults/.

Вы можете настроить Visual Studio для чтения пакетов NuGet, следуя этим шагам:

1. В Visual Studio щёлкните правой кнопкой мыши решение в обозревателе решений и выберите «Управление пакетами NuGet для решения».
2. Щёлкните значок шестерёнки рядом с раскрывающимся списком «Источники пакетов».
3. Щёлкните значок + (для добавления).
4. Дайте источнику имя, например Lucene.Net Local Packages.
5. Щёлкните кнопку ... рядом с полем «Источник», выберите папку /src/_artifacts/NuGetPackages на локальном компьютере.
6. Щёлкните OK. Затем всё, что вам нужно сделать, это выбрать фид Lucene.Net Local Packages из раскрывающегося списка (в диспетчере пакетов NuGet), и вы сможете искать, устанавливать и обновлять пакеты NuGet так же, как и любой интернет-фид.

Visual Studio

Предварительные требования

1. Visual Studio 2022 или более поздняя версия.
2. .NET 8.0 SDK или более поздней версии.

Выполнение

1. Откройте Lucene.Net.sln в Visual Studio.
2. Выберите целевую платформу для тестирования, открыв .build/TestTargetFramework.props и раскомментировав соответствующий (и закомментировав все остальные).
3. Соберите проект или всё решение и дождитесь, пока Visual Studio обнаружит тесты — это может занять несколько минут.
4. Запустите или отладьте тесты в Test Explorer, при необходимости используя нужные фильтры.

Примечание: При запуске тестов в Visual Studio обязательно установите архитектуру процессора по умолчанию на 64 бита, чтобы избежать нехватки виртуальной памяти в некоторых тестах.

Azure DevOps

Мы настроили файл azure-pipelines.yml с логическими значениями по умолчанию, поэтому любой пользователь с учётной записью Azure DevOps может собрать Lucene.NET и запустить тесты с минимальными усилиями. Даже бесплатная учётная запись Azure DevOps будет работать, но тесты будут выполняться намного быстрее, если учётная запись настроена как общедоступная, что позволяет одновременно запускать до 10 параллельных заданий.

Предварительные требования

1. Учётная запись Azure DevOps.
2. Форк этого репозитория либо на GitHub, либо в Azure DevOps. Остальные инструкции предполагают форк GitHub.

Выполнение