Package org.apache.solr.hdfs.snapshots

Class SolrSnapshotsTool

java.lang.Object

org.apache.solr.hdfs.snapshots.SolrSnapshotsTool

All Implemented Interfaces:

Closeable, AutoCloseable, CLIO

public class SolrSnapshotsTool
extends Object
implements Closeable, CLIO

This class provides utility functions required for Solr snapshots functionality.

Constructor Summary

Constructors

Constructor	Description
SolrSnapshotsTool(String solrZkEnsemble)

Method Summary

Modifier and Type	Method	Description
void	backupCollectionMetaData(String collectionName, String snapshotName, String backupLoc)
void	buildCopyListings(String collectionName, String snapshotName, String localFsPath, String pathPrefix)
void	close()
void	createSnapshot(String collectionName, String snapshotName)	Deprecated. use equivalent snapshot related tool in SnapshotCreateTool
void	deleteSnapshot(String collectionName, String snapshotName)	Deprecated. use equivalent snapshot related tool in SnapshotDeleteTool
void	describeSnapshot(String collectionName, String snapshotName)	Deprecated. use equivalent snapshot related tool in SnapshotDescribeTool
void	exportSnapshot(String collectionName, String snapshotName, String destPath, Optional<String> backupRepo, Optional<String> asyncReqId)	Deprecated. use equivalent snapshot related tool in SnapshotExportTool
Map<String,List<String>>	getIndexFilesPathForSnapshot(String collectionName, String snapshotName, String pathPrefix)
void	listSnapshots(String collectionName)	Deprecated. use equivalent snapshot related tool in SnapshotListTool
static void	main(String[] args)
void	prepareForExport(String collectionName, String snapshotName, String localFsPath, String pathPrefix, String destPath)	HDFS specific step required before exporting a snapshot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SolrSnapshotsTool

public SolrSnapshotsTool(String solrZkEnsemble)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

createSnapshot

@Deprecated(since="9.8.0")
public void createSnapshot(String collectionName,
                           String snapshotName)

Deprecated.

use equivalent snapshot related tool in SnapshotCreateTool

deleteSnapshot

@Deprecated(since="9.8.0")
public void deleteSnapshot(String collectionName,
                           String snapshotName)

Deprecated.

use equivalent snapshot related tool in SnapshotDeleteTool

listSnapshots

@Deprecated(since="9.8.0")
public void listSnapshots(String collectionName)

Deprecated.

use equivalent snapshot related tool in SnapshotListTool

describeSnapshot

@Deprecated(since="9.8.0")
public void describeSnapshot(String collectionName,
                             String snapshotName)

Deprecated.

use equivalent snapshot related tool in SnapshotDescribeTool

getIndexFilesPathForSnapshot

public Map<String,List<String>> getIndexFilesPathForSnapshot(String collectionName,
                                                                   String snapshotName,
                                                                   String pathPrefix)
                                                            throws org.apache.solr.client.solrj.SolrServerException,
                                                                   IOException

Parameters:

pathPrefix - optional

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

buildCopyListings

public void buildCopyListings(String collectionName,
                              String snapshotName,
                              String localFsPath,
                              String pathPrefix)
                       throws org.apache.solr.client.solrj.SolrServerException,
                              IOException

Parameters:

pathPrefix - optional

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

backupCollectionMetaData

public void backupCollectionMetaData(String collectionName,
                                     String snapshotName,
                                     String backupLoc)
                              throws org.apache.solr.client.solrj.SolrServerException,
                                     IOException

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

prepareForExport

public void prepareForExport(String collectionName,
                             String snapshotName,
                             String localFsPath,
                             String pathPrefix,
                             String destPath)

HDFS specific step required before exporting a snapshot

Parameters:

pathPrefix - optional

exportSnapshot

@Deprecated(since="9.8.0")
public void exportSnapshot(String collectionName,
                           String snapshotName,
                           String destPath,
                           Optional<String> backupRepo,
                           Optional<String> asyncReqId)

Deprecated.

use equivalent snapshot related tool in SnapshotExportTool

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException