lidavidm commented on code in PR #4232: URL: https://github.com/apache/arrow-adbc/pull/4232#discussion_r3090281887
########## docs/source/javascript/quickstart.rst: ########## @@ -0,0 +1,241 @@ +.. 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 basic features of ADBC with the SQLite driver for +Node.js. + +Installation +============ + +.. code-block:: shell + + npm install @apache-arrow/adbc-driver-manager apache-arrow + +.. note:: + + The ``@apache-arrow/adbc-driver-manager`` package includes TypeScript + types so you don't need a separate types package to get types. + +.. note:: + + Node.js 22 or later is required. Review Comment: The landing page also lists Deno or Bun; can we list the required versions of those here? ########## docs/source/javascript/quickstart.rst: ########## @@ -0,0 +1,241 @@ +.. 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 basic features of ADBC with the SQLite driver for +Node.js. + +Installation +============ + +.. code-block:: shell + + npm install @apache-arrow/adbc-driver-manager apache-arrow + +.. note:: + + The ``@apache-arrow/adbc-driver-manager`` package includes TypeScript + types so you don't need a separate types package to get types. + +.. note:: + + Node.js 22 or later is required. + +To use any driver with the JavaScript driver manager, you'll need install the +appropriate driver shared library for your platform separately and pass the +absolute path to the driver manager. + +Some examples for the SQLite driver are provided below for convenience: + +`conda-forge <https://conda-forge.org/>`_: + +.. code-block:: shell + + conda create -n adbc-sqlite -c conda-forge adbc-driver-sqlite + conda run -n adbc-sqlite python -c "import adbc_driver_sqlite; print(adbc_driver_sqlite._driver_path())" + +`PyPI <https://pypi.org>`_: + +.. code-block:: shell + + python -m venv .venv + source .venv/bin/activate + pip install adbc-driver-sqlite + python -c "import adbc_driver_sqlite; print(adbc_driver_sqlite._driver_path())" + +For apt and dnf packages, see :doc:`/driver/installation`. + +Creating a Database and Connection +================================== + +The entry point is ``AdbcDatabase``. Pass a ``driver`` option to identify the +backend — either a short name (resolved via :doc:`/format/driver_manifests` +search paths) or absolute path to a driver shared library: + +.. code-block:: javascript + + import { AdbcDatabase } from '@apache-arrow/adbc-driver-manager' + + // Open a connection to an in-memory SQLite database. + const db = new AdbcDatabase({ driver: 'sqlite' }) + const conn = await db.connect() Review Comment: Do JS users normally omit semicolons? I was under the impression that that was not encouraged due to having surprising edge cases ########## docs/source/javascript/quickstart.rst: ########## @@ -0,0 +1,241 @@ +.. 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 basic features of ADBC with the SQLite driver for +Node.js. + +Installation +============ + +.. code-block:: shell + + npm install @apache-arrow/adbc-driver-manager apache-arrow + +.. note:: + + The ``@apache-arrow/adbc-driver-manager`` package includes TypeScript + types so you don't need a separate types package to get types. + +.. note:: + + Node.js 22 or later is required. + +To use any driver with the JavaScript driver manager, you'll need install the +appropriate driver shared library for your platform separately and pass the +absolute path to the driver manager. Review Comment: This is a bit awkward but unavoidable. Maybe we also need a toplevel page listing thirdparty ADBC drivers now that SingleStore, Exasol, etc. have theirs. -- 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]
