Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-15447

Improve javadocs description for Delete methods

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • None
    • 2.0.0
    • API, documentation
    • None
    • Reviewed

    Description

      Current javadoc for Delete operation is a bit confusing. Even though initial section does describe the proper behaviour, where calling delete without specifying timestamp will only delete records from now to the past, this is not as clear in the method specific description

      public Delete(byte[] row)
      Create a Delete operation for the specified row.
      If no further operations are done, this will delete everything associated with the specified row (all versions of all columns in all families).
      
      Parameters:
      row - row key
      

      The description can lead to the conclusion that all versions will be deleted. But that's not true if a row has a future timestamp. Although this is a very unusual scenario (having a future timestamp), it should still be clarified.

      Attachments

        1. HBASE-15447.patch
          0.8 kB
          Wellington Chevreuil
        2. HBASE-15447-v1.patch
          1 kB
          M Linville

        Activity

          People

            wchevreuil Wellington Chevreuil
            wchevreuil Wellington Chevreuil
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: