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

Fix JavaDoc for put(List<Put> puts) in HTableInterface

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • 0.90.1
    • 0.90.3
    • Client
    • None
    • Reviewed

    Description

      We say this in the interface:

        /**
         * Puts some data in the table, in batch.
         * <p>
         * If {@link #isAutoFlush isAutoFlush} is false, the update is buffered
         * until the internal buffer is full.
         * @param puts The list of mutations to apply.  The list gets modified by this
         * method (in particular it gets re-ordered, so the order in which the elements
         * are inserted in the list gives no guarantee as to the order in which the
         * {@link Put}s are executed).
         * @throws IOException if a remote or network exception occurs. In that case
         * the {@code puts} argument will contain the {@link Put} instances that
         * have not be successfully applied.
         * @since 0.20.0
         */
        void put(List<Put> puts) throws IOException;
      

      This is outdated and needs to be updated to reflect that this is nothing else but a client side iteration over all puts, but using the write buffer to aggregate to one RPC. The list is never modified and after the call contains the same number of elements.

      Attachments

        1. HBASE-3634.r1.diff
          1 kB
          Harsh J

        Activity

          People

            qwertymaniac Harsh J
            larsgeorge Lars George
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: