Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class IndexSplitter

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Inheritance
    object
    IndexSplitter
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.Misc.dll
    Syntax
    public class IndexSplitter

    Constructors

    IndexSplitter(DirectoryInfo)

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Declaration
    public IndexSplitter(DirectoryInfo dir)
    Parameters
    Type Name Description
    DirectoryInfo dir

    Properties

    Infos

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Declaration
    public SegmentInfos Infos { get; set; }
    Property Value
    Type Description
    SegmentInfos

    Methods

    ListSegments()

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Declaration
    public virtual void ListSegments()

    Main(string[])

    LUCENENET specific: In the Java implementation, this Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to this method: index copy-segments, index delete-segments, and index list-segments

    Declaration
    public static void Main(string[] args)
    Parameters
    Type Name Description
    string[] args

    The command line arguments

    Remove(ICollection<string>)

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Declaration
    public virtual void Remove(ICollection<string> segs)
    Parameters
    Type Name Description
    ICollection<string> segs

    Split(DirectoryInfo, ICollection<string>)

    Command-line tool that enables listing segments in an index, copying specific segments to another index, and deleting segments from an index.

    This tool does file-level copying of segments files. This means it's unable to split apart a single segment into multiple segments. For example if your index is a single segment, this tool won't help. Also, it does basic file-level copying (using simple Stream) so it will not work with non FSDirectory Directory impls.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    You can easily accidentally remove segments from your index so be careful!

    LUCENENET specific: In the Java implementation, this class' Main method was intended to be called from the command line. However, in .NET a method within a DLL can't be directly called from the command line so we provide a .NET tool, lucene-cli, with three commands that map to that method: index copy-segments, index delete-segments, and index list-segments
    Declaration
    public virtual void Split(DirectoryInfo destDir, ICollection<string> segs)
    Parameters
    Type Name Description
    DirectoryInfo destDir
    ICollection<string> segs
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.