HBASE-13466 Document deprecations in 1.x - Part 1 (Lars Francke)
This commit is contained in:
parent
39b7a55580
commit
566dfda5b7
|
@ -87,7 +87,10 @@ public class ClusterStatus extends VersionedWritable {
|
|||
|
||||
/**
|
||||
* Constructor, for Writable
|
||||
* @deprecated Used by Writables and Writables are going away.
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-6038">HBASE-6038</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Used by Writables and Writables are going away.
|
||||
*/
|
||||
@Deprecated
|
||||
public ClusterStatus() {
|
||||
|
@ -221,8 +224,12 @@ public class ClusterStatus extends VersionedWritable {
|
|||
* Returns detailed region server information: A list of
|
||||
* {@link ServerName}.
|
||||
* @return region server information
|
||||
* @deprecated Use {@link #getServers()}
|
||||
* @deprecated As of release 0.92
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-1502">HBASE-1502</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #getServers()}.
|
||||
*/
|
||||
@Deprecated
|
||||
public Collection<ServerName> getServerInfo() {
|
||||
return getServers();
|
||||
}
|
||||
|
|
|
@ -285,8 +285,11 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
private int cachedMaxVersions = UNINITIALIZED;
|
||||
|
||||
/**
|
||||
* Default constructor. Must be present for Writable.
|
||||
* @deprecated Used by Writables and Writables are going away.
|
||||
* Default constructor.
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-5453">HBASE-5453</a>).
|
||||
* This will be made private in HBase 2.0.0.
|
||||
* Used by Writables and Writables are going away.
|
||||
*/
|
||||
@Deprecated
|
||||
// Make this private rather than remove after deprecation period elapses. Its needed by pb
|
||||
|
@ -356,7 +359,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
* other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains
|
||||
* a <code>:</code>
|
||||
* @throws IllegalArgumentException if the number of versions is <= 0
|
||||
* @deprecated use {@link #HColumnDescriptor(String)} and setters
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-">HBASE-</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #HColumnDescriptor(String)} and setters.
|
||||
*/
|
||||
@Deprecated
|
||||
public HColumnDescriptor(final byte [] familyName, final int maxVersions,
|
||||
|
@ -388,7 +394,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
* other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains
|
||||
* a <code>:</code>
|
||||
* @throws IllegalArgumentException if the number of versions is <= 0
|
||||
* @deprecated use {@link #HColumnDescriptor(String)} and setters
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-">HBASE-</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #HColumnDescriptor(String)} and setters.
|
||||
*/
|
||||
@Deprecated
|
||||
public HColumnDescriptor(final byte [] familyName, final int maxVersions,
|
||||
|
@ -428,7 +437,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
* other than 'word' characters: i.e. <code>[a-zA-Z_0-9]</code> or contains
|
||||
* a <code>:</code>
|
||||
* @throws IllegalArgumentException if the number of versions is <= 0
|
||||
* @deprecated use {@link #HColumnDescriptor(String)} and setters
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-">HBASE-</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #HColumnDescriptor(String)} and setters.
|
||||
*/
|
||||
@Deprecated
|
||||
public HColumnDescriptor(final byte[] familyName, final int minVersions,
|
||||
|
@ -670,7 +682,12 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
return setValue(COMPRESSION, type.getName().toUpperCase());
|
||||
}
|
||||
|
||||
/** @return data block encoding algorithm used on disk */
|
||||
/**
|
||||
* @return data block encoding algorithm used on disk
|
||||
* @deprecated As of release 0.98
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9870">HBASE-9870</a>).
|
||||
* This will be removed in HBase 2.0.0. See {@link #getDataBlockEncoding()}}
|
||||
*/
|
||||
@Deprecated
|
||||
public DataBlockEncoding getDataBlockEncodingOnDisk() {
|
||||
return getDataBlockEncoding();
|
||||
|
@ -680,6 +697,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
* This method does nothing now. Flag ENCODE_ON_DISK is not used
|
||||
* any more. Data blocks have the same encoding in cache as on disk.
|
||||
* @return this (for chained invocation)
|
||||
* @deprecated As of release 0.98
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9870">HBASE-9870</a>).
|
||||
* This will be removed in HBase 2.0.0. This method does nothing now.
|
||||
*/
|
||||
@Deprecated
|
||||
public HColumnDescriptor setEncodeOnDisk(boolean encodeOnDisk) {
|
||||
|
@ -727,7 +747,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
/**
|
||||
* @return Whether KV tags should be compressed along with DataBlockEncoding. When no
|
||||
* DataBlockEncoding is been used, this is having no effect.
|
||||
* @deprecated Use {@link #isCompressTags()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #isCompressTags()} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldCompressTags() {
|
||||
|
@ -805,7 +827,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
* @param keepDeletedCells True if deleted rows should not be collected
|
||||
* immediately.
|
||||
* @return this (for chained invocation)
|
||||
* @deprecated use {@link #setKeepDeletedCells(KeepDeletedCells)}
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-12363">HBASE-12363</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #setKeepDeletedCells(KeepDeletedCells)}.
|
||||
*/
|
||||
@Deprecated
|
||||
public HColumnDescriptor setKeepDeletedCells(boolean keepDeletedCells) {
|
||||
|
@ -915,7 +940,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
|
||||
/**
|
||||
* @return true if we should cache data blocks on write
|
||||
* @deprecated Use {@link #isCacheDataOnWrite()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #isCacheDataOnWrite()}} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldCacheDataOnWrite() {
|
||||
|
@ -940,7 +967,9 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
/**
|
||||
* @return true if we should cache data blocks in the L1 cache (if block cache deploy
|
||||
* has more than one tier; e.g. we are using CombinedBlockCache).
|
||||
* @deprecated Use {@link #isCacheDataInL1()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #isCacheDataInL1()}} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldCacheDataInL1() {
|
||||
|
@ -972,7 +1001,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
|
||||
/**
|
||||
* @return true if we should cache index blocks on write
|
||||
* @deprecated Use {@link #isCacheIndexesOnWrite()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #isCacheIndexesOnWrite()} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldCacheIndexesOnWrite() {
|
||||
|
@ -996,7 +1028,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
|
||||
/**
|
||||
* @return true if we should cache bloomfilter blocks on write
|
||||
* @deprecated Use {@link #isCacheBloomsOnWrite()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #isCacheBloomsOnWrite()}} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldCacheBloomsOnWrite() {
|
||||
|
@ -1021,7 +1056,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
/**
|
||||
* @return true if we should evict cached blocks from the blockcache on
|
||||
* close
|
||||
* @deprecated {@link #isEvictBlocksOnClose()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #isEvictBlocksOnClose()}} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldEvictBlocksOnClose() {
|
||||
|
@ -1046,7 +1084,10 @@ public class HColumnDescriptor implements WritableComparable<HColumnDescriptor>
|
|||
|
||||
/**
|
||||
* @return true if we should prefetch blocks into the blockcache on open
|
||||
* @deprecated Use {@link #isPrefetchBlocksOnOpen()} instead
|
||||
* @deprecated As of release 1.0.0
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-10870">HBASE-10870</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #isPrefetchBlocksOnOpen()}}} instead.
|
||||
*/
|
||||
@Deprecated
|
||||
public boolean shouldPrefetchBlocksOnOpen() {
|
||||
|
|
|
@ -86,7 +86,8 @@ public class HRegionInfo implements Comparable<HRegionInfo> {
|
|||
* the hbase:meta table.
|
||||
*
|
||||
* Pre-0.92:
|
||||
* HRI.VERSION == 0 and HConstants.META_VERSION does not exist (is not stored at hbase:meta table)
|
||||
* HRI.VERSION == 0 and HConstants.META_VERSION does not exist
|
||||
* (is not stored at hbase:meta table)
|
||||
* HRegionInfo had an HTableDescriptor reference inside it.
|
||||
* HRegionInfo is serialized as Writable to hbase:meta table.
|
||||
* For 0.92.x and 0.94.x:
|
||||
|
@ -257,7 +258,10 @@ public class HRegionInfo implements Comparable<HRegionInfo> {
|
|||
}
|
||||
|
||||
/** Default constructor - creates empty object
|
||||
* @deprecated Used by Writables and Writables are going away.
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-5453">HBASE-5453</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Used by Writables and Writables are going away.
|
||||
*/
|
||||
@Deprecated
|
||||
public HRegionInfo() {
|
||||
|
@ -509,7 +513,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> {
|
|||
* Gets the table name from the specified region name.
|
||||
* @param regionName
|
||||
* @return Table name.
|
||||
* @deprecated Since 0.96.0; use #getTable(byte[])
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #getTable(byte[])}.
|
||||
*/
|
||||
@Deprecated
|
||||
public static byte [] getTableName(byte[] regionName) {
|
||||
|
@ -676,7 +682,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> {
|
|||
/**
|
||||
* Get current table name of the region
|
||||
* @return byte array of table name
|
||||
* @deprecated Since 0.96.0; use #getTable()
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #getTable()}.
|
||||
*/
|
||||
@Deprecated
|
||||
public byte [] getTableName() {
|
||||
|
@ -1264,7 +1272,9 @@ public class HRegionInfo implements Comparable<HRegionInfo> {
|
|||
if (in.markSupported()) { //read it with mark()
|
||||
in.mark(pblen);
|
||||
}
|
||||
int read = in.read(pbuf); //assumption: if Writable serialization, it should be longer than pblen.
|
||||
|
||||
//assumption: if Writable serialization, it should be longer than pblen.
|
||||
int read = in.read(pbuf);
|
||||
if (read != pblen) throw new IOException("read=" + read + ", wanted=" + pblen);
|
||||
if (ProtobufUtil.isPBMagicPrefix(pbuf)) {
|
||||
return convert(HBaseProtos.RegionInfo.parseDelimitedFrom(in));
|
||||
|
|
|
@ -309,7 +309,10 @@ public class HTableDescriptor implements WritableComparable<HTableDescriptor> {
|
|||
/**
|
||||
* Default constructor which constructs an empty object.
|
||||
* For deserializing an HTableDescriptor instance only.
|
||||
* @deprecated Used by Writables and Writables are going away.
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-5453">HBASE-5453</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Used by Writables and Writables are going away.
|
||||
*/
|
||||
@Deprecated
|
||||
public HTableDescriptor() {
|
||||
|
@ -1107,7 +1110,7 @@ public class HTableDescriptor implements WritableComparable<HTableDescriptor> {
|
|||
* This compares the content of the two descriptors and not the reference.
|
||||
*
|
||||
* @return 0 if the contents of the descriptors are exactly matching,
|
||||
* 1 if there is a mismatch in the contents
|
||||
* 1 if there is a mismatch in the contents
|
||||
*/
|
||||
@Override
|
||||
public int compareTo(final HTableDescriptor other) {
|
||||
|
|
|
@ -166,7 +166,9 @@ public class ClientScanner extends AbstractClientScanner {
|
|||
|
||||
/**
|
||||
* @return Table name
|
||||
* @deprecated Since 0.96.0; use {@link #getTable()}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0. Use {@link #getTable()}.
|
||||
*/
|
||||
@Deprecated
|
||||
protected byte [] getTableName() {
|
||||
|
|
|
@ -1138,7 +1138,10 @@ public class HTable implements HTableInterface {
|
|||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}.
|
||||
*/
|
||||
@Deprecated
|
||||
@Override
|
||||
|
|
|
@ -46,7 +46,10 @@ public interface HTableInterface extends Table {
|
|||
byte[] getTableName();
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}.
|
||||
*/
|
||||
@Deprecated
|
||||
long incrementColumnValue(final byte [] row, final byte [] family,
|
||||
|
|
|
@ -682,7 +682,10 @@ public class LoadIncrementalHFiles extends Configured implements Tool {
|
|||
}
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link #tryAtomicRegionLoad(Connection, TableName, byte[], Collection)}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link #tryAtomicRegionLoad(Connection, TableName, byte[], Collection)}.
|
||||
*/
|
||||
@Deprecated
|
||||
protected List<LoadQueueItem> tryAtomicRegionLoad(final HConnection conn,
|
||||
|
|
|
@ -91,7 +91,10 @@ implements Writable, Comparable<TableSplit> {
|
|||
}
|
||||
|
||||
/**
|
||||
* @deprecated Since 0.96.0; use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}.
|
||||
*/
|
||||
@Deprecated
|
||||
public TableSplit(final byte [] tableName, Scan scan, byte [] startRow, byte [] endRow,
|
||||
|
@ -139,7 +142,10 @@ implements Writable, Comparable<TableSplit> {
|
|||
}
|
||||
|
||||
/**
|
||||
* @deprecated Since 0.96.0; use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}
|
||||
* @deprecated As of release 0.96
|
||||
* (<a href="https://issues.apache.org/jira/browse/HBASE-9508">HBASE-9508</a>).
|
||||
* This will be removed in HBase 2.0.0.
|
||||
* Use {@link TableSplit#TableSplit(TableName, byte[], byte[], String)}.
|
||||
*/
|
||||
@Deprecated
|
||||
public TableSplit(final byte [] tableName, byte[] startRow, byte[] endRow,
|
||||
|
|
Loading…
Reference in New Issue