From 9679c5f306345a14453f45f80a9c16994eae6cfd Mon Sep 17 00:00:00 2001 From: Paul Masurel Date: Thu, 27 Jan 2022 15:36:42 +0900 Subject: [PATCH] Rename quickwit-inc -> quickwit-oss --- CHANGELOG.md | 10 +++++----- Cargo.toml | 7 ++----- README.md | 23 +++++++---------------- bitpacker/Cargo.toml | 2 +- doc/src/index_sorting.md | 4 ++-- query-grammar/Cargo.toml | 5 ++--- src/indexer/merger.rs | 2 +- src/lib.rs | 2 +- tests/failpoints/mod.rs | 4 ++-- 9 files changed, 23 insertions(+), 36 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 472f9672b..5d9abb667 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,12 @@ Tantivy 0.17 ================================ -- LogMergePolicy now triggers merges if the ratio of deleted documents reaches a threshold (@shikhar @fulmicoton) [#115](https://github.com/quickwit-inc/tantivy/issues/115) +- LogMergePolicy now triggers merges if the ratio of deleted documents reaches a threshold (@shikhar @fulmicoton) [#115](https://github.com/quickwit-oss/tantivy/issues/115) - Adds a searcher Warmer API (@shikhar @fulmicoton) - Change to non-strict schema. Ignore fields in data which are not defined in schema. Previously this returned an error. #1211 - Facets are necessarily indexed. Existing index with indexed facets should work out of the box. Index without facets that are marked with index: false should be broken (but they were already broken in a sense). (@fulmicoton) #1195 . -- Bugfix that could in theory impact durability in theory on some filesystems [#1224](https://github.com/quickwit-inc/tantivy/issues/1224) -- Schema now offers not indexing fieldnorms (@lpouget) [#922](https://github.com/quickwit-inc/tantivy/issues/922) -- Reduce the number of fsync calls [#1225](https://github.com/quickwit-inc/tantivy/issues/1225) +- Bugfix that could in theory impact durability in theory on some filesystems [#1224](https://github.com/quickwit-oss/tantivy/issues/1224) +- Schema now offers not indexing fieldnorms (@lpouget) [#922](https://github.com/quickwit-oss/tantivy/issues/922) +- Reduce the number of fsync calls [#1225](https://github.com/quickwit-oss/tantivy/issues/1225) Tantivy 0.16.2 ================================ @@ -128,7 +128,7 @@ Tantivy 0.12.0 ## How to update? Crates relying on custom tokenizer, or registering tokenizer in the manager will require some -minor changes. Check https://github.com/quickwit-inc/tantivy/blob/main/examples/custom_tokenizer.rs +minor changes. Check https://github.com/quickwit-oss/tantivy/blob/main/examples/custom_tokenizer.rs to check for some code sample. Tantivy 0.11.3 diff --git a/Cargo.toml b/Cargo.toml index 4de0048ed..28d05c75f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,8 +6,8 @@ license = "MIT" categories = ["database-implementations", "data-structures"] description = """Search engine library""" documentation = "https://docs.rs/tantivy/" -homepage = "https://github.com/quickwit-inc/tantivy" -repository = "https://github.com/quickwit-inc/tantivy" +homepage = "https://github.com/quickwit-oss/tantivy" +repository = "https://github.com/quickwit-oss/tantivy" readme = "README.md" keywords = ["search", "information", "retrieval"] edition = "2018" @@ -95,9 +95,6 @@ unstable = [] # useful for benches. [workspace] members = ["query-grammar", "bitpacker", "common", "fastfield_codecs", "ownedbytes"] -[badges] -travis-ci = { repository = "tantivy-search/tantivy" } - # Following the "fail" crate best practises, we isolate # tests that define specific behavior in fail check points # in a different binary. diff --git a/README.md b/README.md index 84338d4e0..4004d1a13 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,13 @@ [![Docs](https://docs.rs/tantivy/badge.svg)](https://docs.rs/crate/tantivy/) -[![Build Status](https://github.com/quickwit-inc/tantivy/actions/workflows/test.yml/badge.svg)](https://github.com/quickwit-inc/tantivy/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/quickwit-inc/tantivy/branch/main/graph/badge.svg)](https://codecov.io/gh/quickwit-inc/tantivy) +[![Build Status](https://github.com/quickwit-oss/tantivy/actions/workflows/test.yml/badge.svg)](https://github.com/quickwit-oss/tantivy/actions/workflows/test.yml) +[![codecov](https://codecov.io/gh/quickwit-oss/tantivy/branch/main/graph/badge.svg)](https://codecov.io/gh/quickwit-oss/tantivy) [![Join the chat at https://discord.gg/MT27AG5EVE](https://shields.io/discord/908281611840282624?label=chat%20on%20discord)](https://discord.gg/MT27AG5EVE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Crates.io](https://img.shields.io/crates/v/tantivy.svg)](https://crates.io/crates/tantivy) ![Tantivy](https://tantivy-search.github.io/logo/tantivy-logo.png) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/0)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/0) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/1)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/1) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/2)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/2) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/3)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/3) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/4)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/4) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/5)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/5) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/6)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/6) -[![](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/images/7)](https://sourcerer.io/fame/fulmicoton/tantivy-search/tantivy/links/7) - **Tantivy** is a **full text search engine library** written in Rust. It is closer to [Apache Lucene](https://lucene.apache.org/) than to [Elasticsearch](https://www.elastic.co/products/elasticsearch) or [Apache Solr](https://lucene.apache.org/solr/) in the sense it is not @@ -27,7 +18,7 @@ Tantivy is, in fact, strongly inspired by Lucene's design. # Benchmark -The following [benchmark](https://tantivy-search.github.io/bench/) break downs +The following [benchmark](https://tantivy-search.github.io/bench/) break downs performance for different type of queries / collection. Your mileage WILL vary depending on the nature of queries and their load. @@ -57,7 +48,7 @@ Your mileage WILL vary depending on the nature of queries and their load. ## Non-features - Distributed search is out of the scope of Tantivy. That being said, Tantivy is a -library upon which one could build a distributed search. Serializable/mergeable collector state for instance, +library upon which one could build a distributed search. Serializable/mergeable collector state for instance, are within the scope of Tantivy. @@ -66,14 +57,14 @@ are within the scope of Tantivy. Tantivy works on stable Rust (>= 1.27) and supports Linux, MacOS, and Windows. - [Tantivy's simple search example](https://tantivy-search.github.io/examples/basic_search.html) -- [tantivy-cli and its tutorial](https://github.com/tantivy-search/tantivy-cli) - `tantivy-cli` is an actual command line interface that makes it easy for you to create a search engine, +- [tantivy-cli and its tutorial](https://github.com/quickwit-oss/tantivy-cli) - `tantivy-cli` is an actual command line interface that makes it easy for you to create a search engine, index documents, and search via the CLI or a small server with a REST API. It walks you through getting a wikipedia search engine up and running in a few minutes. - [Reference doc for the last released version](https://docs.rs/tantivy/) # How can I support this project? -There are many ways to support this project. +There are many ways to support this project. - Use Tantivy and tell us about your experience on [Discord](https://discord.gg/MT27AG5EVE) or by email (paul.masurel@gmail.com) - Report bugs @@ -92,7 +83,7 @@ Tantivy compiles on stable Rust but requires `Rust >= 1.27`. To check out and run tests, you can simply run: ```bash - git clone https://github.com/quickwit-inc/tantivy.git + git clone https://github.com/quickwit-oss/tantivy.git cd tantivy cargo build ``` diff --git a/bitpacker/Cargo.toml b/bitpacker/Cargo.toml index 74c1341cd..43a339186 100644 --- a/bitpacker/Cargo.toml +++ b/bitpacker/Cargo.toml @@ -6,7 +6,7 @@ authors = ["Paul Masurel "] license = "MIT" categories = [] description = """Tantivy-sub crate: bitpacking""" -repository = "https://github.com/quickwit-inc/tantivy" +repository = "https://github.com/quickwit-oss/tantivy" keywords = [] diff --git a/doc/src/index_sorting.md b/doc/src/index_sorting.md index 87822e07d..49627c25a 100644 --- a/doc/src/index_sorting.md +++ b/doc/src/index_sorting.md @@ -38,7 +38,7 @@ Note: Tantivy 0.16 does not do this optimization yet. In principle there are many algorithms possible that exploit the monotonically increasing nature. (aggregations maybe?) ## Usage -The index sorting can be configured setting [`sort_by_field`](https://github.com/quickwit-inc/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/core/index_meta.rs#L238) on `IndexSettings` and passing it to a `IndexBuilder`. As of tantvy 0.16 only fast fields are allowed to be used. +The index sorting can be configured setting [`sort_by_field`](https://github.com/quickwit-oss/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/core/index_meta.rs#L238) on `IndexSettings` and passing it to a `IndexBuilder`. As of tantvy 0.16 only fast fields are allowed to be used. ``` let settings = IndexSettings { @@ -55,7 +55,7 @@ let index = index_builder.create_in_ram().unwrap(); ## Implementation details -Sorting an index is applied in the serialization step. In general there are two serialization steps: [Finishing a single segment](https://github.com/quickwit-inc/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/indexer/segment_writer.rs#L338) and [merging multiple segments](https://github.com/quickwit-inc/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/indexer/merger.rs#L1073). +Sorting an index is applied in the serialization step. In general there are two serialization steps: [Finishing a single segment](https://github.com/quickwit-oss/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/indexer/segment_writer.rs#L338) and [merging multiple segments](https://github.com/quickwit-oss/tantivy/blob/000d76b11a139a84b16b9b95060a1c93e8b9851c/src/indexer/merger.rs#L1073). In both cases we generate a docid mapping reflecting the sort. This mapping is used when serializing the different components (doc store, fastfields, posting list, normfield, facets). diff --git a/query-grammar/Cargo.toml b/query-grammar/Cargo.toml index 1e77463a2..64d505774 100644 --- a/query-grammar/Cargo.toml +++ b/query-grammar/Cargo.toml @@ -5,9 +5,8 @@ authors = ["Paul Masurel "] license = "MIT" categories = ["database-implementations", "data-structures"] description = """Search engine library""" -documentation = "https://quickwit-inc.github.io/tantivy/tantivy/index.html" -homepage = "https://github.com/quickwit-inc/tantivy" -repository = "https://github.com/quickwit-inc/tantivy" +homepage = "https://github.com/quickwit-oss/tantivy" +repository = "https://github.com/quickwit-oss/tantivy" readme = "README.md" keywords = ["search", "information", "retrieval"] edition = "2018" diff --git a/src/indexer/merger.rs b/src/indexer/merger.rs index d16b946ba..047dd0df1 100644 --- a/src/indexer/merger.rs +++ b/src/indexer/merger.rs @@ -1060,7 +1060,7 @@ impl IndexMerger { // the doc stores would be on average half full, given total randomness (which // is not the case here, but not sure how it behaves exactly). // - // https://github.com/quickwit-inc/tantivy/issues/1053 + // https://github.com/quickwit-oss/tantivy/issues/1053 // // take 7 in order to not walk over all checkpoints. || store_reader.block_checkpoints().take(7).count() < 6 diff --git a/src/lib.rs b/src/lib.rs index 5b2058015..5b3761adf 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -105,7 +105,7 @@ //! A good place for you to get started is to check out //! the example code ( //! [literate programming](https://tantivy-search.github.io/examples/basic_search.html) / -//! [source code](https://github.com/quickwit-inc/tantivy/blob/main/examples/basic_search.rs)) +//! [source code](https://github.com/quickwit-oss/tantivy/blob/main/examples/basic_search.rs)) #[cfg_attr(test, macro_use)] extern crate serde_json; diff --git a/tests/failpoints/mod.rs b/tests/failpoints/mod.rs index 47f7dd958..0e33313db 100644 --- a/tests/failpoints/mod.rs +++ b/tests/failpoints/mod.rs @@ -66,9 +66,9 @@ fn test_write_commit_fails() -> tantivy::Result<()> { } // Motivated by -// - https://github.com/quickwit-inc/quickwit/issues/730 +// - https://github.com/quickwit-oss/quickwit/issues/730 // Details at -// - https://github.com/quickwit-inc/tantivy/issues/1198 +// - https://github.com/quickwit-oss/tantivy/issues/1198 #[test] fn test_fail_on_flush_segment() -> tantivy::Result<()> { let _fail_scenario_guard = fail::FailScenario::setup();