com.yelp.nrtsearch.server.cli.BackupIndexCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of server Show documentation

GRPC lucene server using near-real-time replication

There is a newer version: 1.0.0-beta.1

/*
 * Copyright 2020 Yelp Inc.
 *
 * Licensed 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 com.yelp.nrtsearch.server.cli;

import com.yelp.nrtsearch.server.grpc.LuceneServerClient;
import java.util.concurrent.Callable;
import picocli.CommandLine;

@CommandLine.Command(name = BackupIndexCommand.BACKUP_INDEX, description = "Backup index")
public class BackupIndexCommand implements Callable {
  public static final String BACKUP_INDEX = "backupIndex";

  @CommandLine.ParentCommand private LuceneClientCommand baseCmd;

  @CommandLine.Option(
      names = {"-i", "--indexName"},
      description = "Name of the index which is to be backed up",
      required = true)
  private String indexName;

  public String getIndexName() {
    return indexName;
  }

  @CommandLine.Option(
      names = {"-s", "--serviceName"},
      description = "Name of the service which is to be backed up",
      required = true)
  private String serviceName;

  public String getServiceName() {
    return serviceName;
  }

  @CommandLine.Option(
      names = {"-r", "--resourceName"},
      description = "Name of the resource which is to be backed up",
      required = true)
  private String resourceName;

  public String getResourceName() {
    return resourceName;
  }

  @CommandLine.Option(
      names = {"-c", "--completeDirectory"},
      description =
          "Backup complete directory including all current snapshots if true (may backup corrupt segments if backup is created while indexing is happening), otherwise only backup the required segments and segment files")
  private boolean completeDirectory;

  public boolean getCompleteDirectory() {
    return completeDirectory;
  }

  @CommandLine.Option(
      names = {"--stream"},
      description =
          "Stream the index archive directly to s3, instead of writing to a file first (experimental)")
  private boolean stream;

  public boolean getStream() {
    return stream;
  }

  @Override
  public Integer call() throws Exception {
    LuceneServerClient client = baseCmd.getClient();
    try {
      client.backupIndex(
          getIndexName(), getServiceName(), getResourceName(), getCompleteDirectory(), getStream());
    } finally {
      client.shutdown();
    }
    return 0;
  }
}