docs: rework library getting started

[nominatim.git] / docs / library / Low-Level-DB-Access.md

diff --git a/docs/library/Low-Level-DB-Access.md b/docs/library/Low-Level-DB-Access.md
index 5101777e7a4596058cbedce08d6dba6c035793fc..84a40b9b04a963f9f1a64a21a83b7ca219d5f047 100644 (file)
--- a/docs/library/Low-Level-DB-Access.md
+++ b/docs/library/Low-Level-DB-Access.md
@@ -1,13 +1,13 @@
 # Low-level connections
 
 The `NominatimAPIAsync` class allows to directly access the underlying
 # Low-level connections
 
 The `NominatimAPIAsync` class allows to directly access the underlying

-database connection to explore the data more directly. Nominatim uses
+database connection to explore the raw data. Nominatim uses

 [SQLAlchemy](https://docs.sqlalchemy.org/) for building queries. Please
 refer to the documentation of the library to understand how to write SQL.
 
 To get access to a search connection, use the `begin()` function of your
 [SQLAlchemy](https://docs.sqlalchemy.org/) for building queries. Please
 refer to the documentation of the library to understand how to write SQL.
 
 To get access to a search connection, use the `begin()` function of your

-API object. The function returns a context manager. Use with a `with`
-statement. This returns a `SearchConnection` object described below. Its
+API object. This returns a `SearchConnection` object described below
+wrapped in a context manager. Its

 `t` property has definitions for all Nominatim search tables. For an
 overview of available tables, refer to the
 [Development Layout](../develop/Database-Layout.md) in in the development
 `t` property has definitions for all Nominatim search tables. For an
 overview of available tables, refer to the
 [Development Layout](../develop/Database-Layout.md) in in the development


@@ -26,7 +26,7 @@ the placex table:
 import asyncio
 from pathlib import Path
 import sqlalchemy as sa
 import asyncio
 from pathlib import Path
 import sqlalchemy as sa

-from nominatim.api import NominatimAPIAsync
+from nominatim_api import NominatimAPIAsync

 
 async def print_table_size():
     api = NominatimAPIAsync(Path('.'))
 
 async def print_table_size():
     api = NominatimAPIAsync(Path('.'))


@@ -45,7 +45,7 @@ asyncio.run(print_table_size())
 
 ## SearchConnection class
 
 
 ## SearchConnection class
 

-::: nominatim.api.SearchConnection
+::: nominatim_api.SearchConnection

     options:
         members:
             - scalar
     options:
         members:
             - scalar