daipom commented on code in PR #3083: URL: https://github.com/apache/arrow-adbc/pull/3083#discussion_r2178907405
########## docs/source/rust/quickstart.rst: ########## @@ -0,0 +1,70 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +========== +Quickstart +========== + +Here we'll briefly tour using ADBC with the `DataFusion`_ driver. + +.. _DataFusion: https://datafusion.apache.org/ + +Installation +============ + +Add a dependency on ``adbc_core`` and ``adbc_datafusion``: + +.. code-block:: shell + + cargo add adbc_core adbc_datafusion + +Loading DataFusion +================== + +Create a driver instance, then a database handle, and then finally a +connection. (This is a bit redundant for something like DataFusion, but the +intent is that the database handle can hold shared state that multiple +connections can share.) + +.. code-block:: rust + + // These traits must be in scope + use adbc_core::{Connection, Database, Driver, Statement}; + + let mut driver = adbc_datafusion::DataFusionDriver {}; + let mut db = driver.new_database().expect("Failed to create database handle"); Review Comment: If this document is targeting version 0.19, it might be preferable to remove this `mut`. (#2788) ```suggestion let db = driver.new_database().expect("Failed to create database handle"); ``` Because `warning: variable does not need to be mutable` will occur after 0.19. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
