]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/library/Low-Level-DB-Access.md
release 4.5.0.post7
[nominatim.git] / docs / library / Low-Level-DB-Access.md
index 5101777e7a4596058cbedce08d6dba6c035793fc..9669906122f31fcbfae3b925dcdd0673cbcbf7bb 100644 (file)
@@ -1,13 +1,13 @@
 # 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
-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
@@ -24,12 +24,11 @@ the placex table:
 
 ```
 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('.'))
+    api = NominatimAPIAsync()
 
     async with api.begin() as conn:
         cnt = await conn.scalar(sa.select(sa.func.count()).select_from(conn.t.placex))
@@ -45,7 +44,7 @@ asyncio.run(print_table_size())
 
 ## SearchConnection class
 
-::: nominatim.api.SearchConnection
+::: nominatim_api.SearchConnection
     options:
         members:
             - scalar