[GitHub] [arrow-adbc] zeroshade commented on a diff in pull request #316: feat(format): Add more canonical options

[GitBox <gi...@apache.org>]

zeroshade commented on code in PR #316:
URL: https://github.com/apache/arrow-adbc/pull/316#discussion_r1063610332


##########
docs/source/format/specification.rst:
##########
@@ -36,6 +36,30 @@ provides a place to hold ownership of the in-memory database.
 - Go: ``Driver``
 - Java: ``org.apache.arrow.adbc.core.AdbcDatabase``
 
+URIs
+----
+
+When specifying the URI of the database, there is a standard option
+name to pass to drivers. This is the string `uri`, available in
+the implementations via helpers:
+
+- C/C++: :c:macro:`ADBC_OPTION_URI`
+- Go: ``OptionKeyURI``
+- Java: ``org.apache.arrow.adbc.core.AdbcDriver#PARAM_URL``
+
+Authentication
+--------------
+
+Standard options are defined for specifying the username and password
+for authentication to a driver. Further authentication options would
+be driver specific, such as a particular driver supporting the use
+of kerberos auth or plain auth, etc.
+
+- C/C++: :c:macro:`ADBC_OPTION_USERNAME` and :c:macro:`ADBC_OPTION_PASSWORD`
+- Go: ``OptionKeyUsername`` and ``OptionKeyPassword``
+- Java: ``org.apache.arrow.adbc.core.AdbcDriver#PARAM_USER`` and ``org.apache.arrow.adbc.core.AdbcDriver#PARAM_PASS``

Review Comment:
   *shrug* i like shorter names and it makes me happy when they are all around the same length haha. But I'll update them to be `USERNAME` and `PASSWORD`



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org