You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2021/11/15 08:11:12 UTC
[GitHub] [lucene] praveennish opened a new pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
praveennish opened a new pull request #439:
URL: https://github.com/apache/lucene/pull/439
<!--
_(If you are a project committer then you may remove some/all of the following template.)_
Before creating a pull request, please file an issue in the ASF Jira system for Lucene:
* https://issues.apache.org/jira/projects/LUCENE
You will need to create an account in Jira in order to create an issue.
The title of the PR should reference the Jira issue number in the form:
* LUCENE-####: <short description of problem or changes>
LUCENE must be fully capitalized. A short description helps people scanning pull requests for items they can work on.
Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. -->
# Description
Lucene currently supports LZ4 and Zlib compression/decompression for StoredFieldsFormat. We propose Zstandard (https://facebook.github.io/zstd/) compression/decompression for StoredFieldsFormat for the following reasons:
* ZStandard is being used in some of the most popular open source projects like Apache Cassandra, Hadoop, and Kafka.
* Zstandard, at the default setting of 3, is expected to show substantial improvements in both compression and decompression speed while compressing at the same ratio as Zlib as per study mentioned by Yann Collet at Facebook
(https://engineering.fb.com/2016/08/31/core-data/smaller-and-faster-data-compression-with-zstandard/).
* Zstandard currently offers 22 different Compression levels, which enable flexible, granular trade-offs between compression speed and ratios for future data. This solution also provides the flexibility of choosing compression levels between 1 and 22. For example, we can use level 1 if speed is most important and level 22 if the size is most important.
* Zstandard designed to scale with modern hardware(https://engineering.fb.com/2016/08/31/core-data/smaller-and-faster-data-compression-with-zstandard/).
# Solution
* Developed a custom codec to enable Zstandard compression/decompression support.
* This custom codec also provides flexibility to add any other compression algorithms.
# Tests
* Added required test case for testing new custom codec. Ran with option -Dtests.codec for newly developed custom codec
# Checklist
Please review the following and check all that apply:
- [X] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/lucene/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [X] I have created a Jira issue and added the issue ID to my pull request title.
- [X] I have given Lucene maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [X] I have developed this patch against the `main` branch.
- [X] I have run `./gradlew check`.
- [X] I have added tests for my changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156981
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
Review comment:
removed static
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156546
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/ZstdDictCompressionMode.java
##########
@@ -0,0 +1,195 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.lucene.codecs.customcompression;
+
+import com.github.luben.zstd.*;
+import java.io.IOException;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.compressing.Compressor;
+import org.apache.lucene.codecs.compressing.Decompressor;
+import org.apache.lucene.store.DataInput;
+import org.apache.lucene.store.DataOutput;
+import org.apache.lucene.util.ArrayUtil;
+import org.apache.lucene.util.BytesRef;
+
+/** Zstandard Compression Mode */
+public class ZstdDictCompressionMode extends CompressionMode {
+ private static final int NUM_SUB_BLOCKS = 10;
+ private final int level;
+ public static final int defaultLevel = 3;
+ private static final int DICT_SIZE_FACTOR = 2;
Review comment:
Changed to 6 in PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156879
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
+
+ case ZSTD_DICT:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
changed to 4096
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156704
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
Changed to 4096 in PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156381
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
Review comment:
Changed to 48KB in PR
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/ZstdDictCompressionMode.java
##########
@@ -0,0 +1,195 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.lucene.codecs.customcompression;
+
+import com.github.luben.zstd.*;
+import java.io.IOException;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.compressing.Compressor;
+import org.apache.lucene.codecs.compressing.Decompressor;
+import org.apache.lucene.store.DataInput;
+import org.apache.lucene.store.DataOutput;
+import org.apache.lucene.util.ArrayUtil;
+import org.apache.lucene.util.BytesRef;
+
+/** Zstandard Compression Mode */
+public class ZstdDictCompressionMode extends CompressionMode {
+ private static final int NUM_SUB_BLOCKS = 10;
+ private final int level;
+ public static final int defaultLevel = 3;
+ private static final int DICT_SIZE_FACTOR = 2;
Review comment:
Changed to 6 in PR
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
Changed to 4096 in PR
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
+
+ case ZSTD_DICT:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
changed to 4096
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
Review comment:
removed static
##########
File path: lucene/codecs/build.gradle
##########
@@ -20,6 +20,9 @@ apply plugin: 'java-library'
description = 'Lucene codecs and postings formats'
dependencies {
+
+ implementation project(':lucene:core')
moduleImplementation project(':lucene:core')
+ moduleImplementation 'com.github.luben:zstd-jni:1.5.0-4'
Review comment:
Hi Tobias,
I have tested 1.5.0-X and the data looks to be very promising with the current version. I have not tested 1.5.1-X JNI version but https://github.com/facebook/zstd/releases/tag/v1.5.1 looks good and can be picked up in the future since Zstd is very dynamic and we may see a lot of improvements over the current version!
Thanks!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] tobijdc commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
tobijdc commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r777750326
##########
File path: lucene/codecs/build.gradle
##########
@@ -20,6 +20,9 @@ apply plugin: 'java-library'
description = 'Lucene codecs and postings formats'
dependencies {
+
+ implementation project(':lucene:core')
moduleImplementation project(':lucene:core')
+ moduleImplementation 'com.github.luben:zstd-jni:1.5.0-4'
Review comment:
Just minor suggestion:
current version is `1.5.1-1`
could bring another few percent compression speed
https://github.com/facebook/zstd/releases/tag/v1.5.1
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] jpountz commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
jpountz commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r777675004
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/ZstdDictCompressionMode.java
##########
@@ -0,0 +1,195 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.lucene.codecs.customcompression;
+
+import com.github.luben.zstd.*;
+import java.io.IOException;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.compressing.Compressor;
+import org.apache.lucene.codecs.compressing.Decompressor;
+import org.apache.lucene.store.DataInput;
+import org.apache.lucene.store.DataOutput;
+import org.apache.lucene.util.ArrayUtil;
+import org.apache.lucene.util.BytesRef;
+
+/** Zstandard Compression Mode */
+public class ZstdDictCompressionMode extends CompressionMode {
+ private static final int NUM_SUB_BLOCKS = 10;
+ private final int level;
+ public static final int defaultLevel = 3;
+ private static final int DICT_SIZE_FACTOR = 2;
Review comment:
Let's do 6 like for BEST_COMPRESSION?
```suggestion
private static final int DICT_SIZE_FACTOR = 6;
```
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
Review comment:
Let's use bigger blocks, like for BEST_COMPRESSION.
```suggestion
private static final int ZSTD_BLOCK_LENGTH = 10 * 48 * 1024;
```
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
4096 docs per chunk at most, like for BEST_COMPRESSION
```suggestion
"CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 4096, 10);
```
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
+
+ /** default constructor */
+ public Lucene90CustomCompressionStoredFieldsFormat() {
+ this(
+ Lucene90CustomCompressionCodec.Mode.ZSTD_DICT,
+ Lucene90CustomCompressionCodec.defaultCompressionLevel);
+ }
+
+ /** Stored fields format with specified compression algo. */
+ public Lucene90CustomCompressionStoredFieldsFormat(
+ Lucene90CustomCompressionCodec.Mode mode, int compressionLevel) {
+ this.mode = Objects.requireNonNull(mode);
+ Lucene90CustomCompressionStoredFieldsFormat.compressionLevel = compressionLevel;
+ }
+
+ @Override
+ public StoredFieldsReader fieldsReader(
+ Directory directory, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
+ String value = si.getAttribute(MODE_KEY);
+ if (value == null) {
+ throw new IllegalStateException("missing value for " + MODE_KEY + " for segment: " + si.name);
+ }
+ Lucene90CustomCompressionCodec.Mode mode = Lucene90CustomCompressionCodec.Mode.valueOf(value);
+ return impl(mode).fieldsReader(directory, si, fn, context);
+ }
+
+ @Override
+ public StoredFieldsWriter fieldsWriter(Directory directory, SegmentInfo si, IOContext context)
+ throws IOException {
+ String previous = si.putAttribute(MODE_KEY, mode.name());
+ if (previous != null && previous.equals(mode.name()) == false) {
+ throw new IllegalStateException(
+ "found existing value for "
+ + MODE_KEY
+ + " for segment: "
+ + si.name
+ + "old="
+ + previous
+ + ", new="
+ + mode.name());
+ }
+ return impl(mode).fieldsWriter(directory, si, context);
+ }
+
+ StoredFieldsFormat impl(Lucene90CustomCompressionCodec.Mode mode) {
+ switch (mode) {
+ case ZSTD:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_NO_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
+
+ case ZSTD_DICT:
+ return new Lucene90CompressingStoredFieldsFormat(
+ "CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 1024, 10);
Review comment:
```suggestion
"CustomCompressionStoredFieldsZSTD", ZSTD_MODE_DICT, ZSTD_BLOCK_LENGTH, 4096, 10);
```
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
+
+ public static final String MODE_KEY =
+ Lucene90CustomCompressionStoredFieldsFormat.class.getSimpleName() + ".mode";
+
+ final Lucene90CustomCompressionCodec.Mode mode;
+
+ private static int compressionLevel;
Review comment:
Let's not make it static?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780156381
##########
File path: lucene/codecs/src/java/org/apache/lucene/codecs/customcompression/Lucene90CustomCompressionStoredFieldsFormat.java
##########
@@ -0,0 +1,103 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.lucene.codecs.customcompression;
+
+import java.io.IOException;
+import java.util.Objects;
+import org.apache.lucene.codecs.StoredFieldsFormat;
+import org.apache.lucene.codecs.StoredFieldsReader;
+import org.apache.lucene.codecs.StoredFieldsWriter;
+import org.apache.lucene.codecs.compressing.CompressionMode;
+import org.apache.lucene.codecs.lucene90.compressing.Lucene90CompressingStoredFieldsFormat;
+import org.apache.lucene.index.FieldInfos;
+import org.apache.lucene.index.SegmentInfo;
+import org.apache.lucene.store.Directory;
+import org.apache.lucene.store.IOContext;
+
+/** Stored field format used by plugaable codec */
+public class Lucene90CustomCompressionStoredFieldsFormat extends StoredFieldsFormat {
+ // chunk size for zstandard
+ private static final int ZSTD_BLOCK_LENGTH = 10 * 8 * 1024;
Review comment:
Changed to 48KB in PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] praveennish commented on a change in pull request #439: LUCENE-8739: custom codec providing Zstandard compression/decompression
Posted by GitBox <gi...@apache.org>.
praveennish commented on a change in pull request #439:
URL: https://github.com/apache/lucene/pull/439#discussion_r780170794
##########
File path: lucene/codecs/build.gradle
##########
@@ -20,6 +20,9 @@ apply plugin: 'java-library'
description = 'Lucene codecs and postings formats'
dependencies {
+
+ implementation project(':lucene:core')
moduleImplementation project(':lucene:core')
+ moduleImplementation 'com.github.luben:zstd-jni:1.5.0-4'
Review comment:
Hi Tobias,
I have tested 1.5.0-X and the data looks to be very promising with the current version. I have not tested 1.5.1-X JNI version but https://github.com/facebook/zstd/releases/tag/v1.5.1 looks good and can be picked up in the future since Zstd is very dynamic and we may see a lot of improvements over the current version!
Thanks!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org