Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-4367

Incorrect documentation for Avatica JSON request/response signatures

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: avatica-1.18.0
    • Component/s: avatica
    • Labels:
      None

      Description

      I noticed a few inconsistencies between what is documented in theĀ Avatica JSON Reference and what the Avatica JDBC driver provides, specifically:

      1. The DatabasePropertyRequest was missing the connection_id field in the example signature.
      2. `RpcMetadata` is actually a response as opposed to a miscellaneous type per here and thus requires a response field. Note I'm not certain if this was intentional, i.e., it being a response, however it it is it seems that it should be renamed to RpcMetadataResponse for consistency.
      3. The supplied ConnectionProperties contains an undocumented dirty field (is_dirty for protobuf).
      4. For the SchemasRequest the catalog and schemaPattern are optional rather than required.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                elserj Josh Elser
                Reporter:
                john.bodley@gmail.com John Bodley
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2h 10m
                  2h 10m