Skip to content

Commit

Permalink
documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
parkervg committed May 14, 2024
1 parent 2f5530c commit 457f900
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,9 @@ SELECT EXISTS(
- [Quickstart](#quickstart)
- [FAQ](#faq)
- [Documentation](#documentation)
- [Databases](#databases)
- [SQLite](#sqlite)
- [PostgreSQL](#postgresql)
- [Execute a BlendSQL Query](#execute-a-blendsql-query)
- [Smoothie](#smoothie)
- [Ingredients](#ingredients)
Expand All @@ -304,7 +307,6 @@ SELECT EXISTS(
- [StringIngredient](#stringingredient)
- [Parsing Natural Language to BlendSQL](#parsing-natural-language-to-blendsql)
- [LLMs](#llms)
- [Databases](#databases)
- [Appendix](#appendix)

For a technical walkthrough of how a BlendSQL query is executed, check out [technical_walkthrough.md](./docs/technical_walkthrough.md).
Expand Down Expand Up @@ -410,6 +412,12 @@ A PostgreSQL database connection.
Can be initialized via the SQLAlchemy input string.
https://docs.sqlalchemy.org/en/20/core/engines.html#postgresql

Example:
```python
from blendsql.db import PostgreSQL
db = PostgreSQL("user:password@localhost/mydatabase")
```

#### Creating a `blendsql` User

When executing a BlendSQL query, there are internal checks to ensure prior to execution that a given query does not contain any 'modify' actions.
Expand All @@ -431,12 +439,6 @@ from blendsql.db import PostgreSQL
db = PostgreSQL("blendsql@localhost:5432/mydb")
```

Example:
```python
from blendsql.db import PostgreSQL
db = PostgreSQL("user:password@localhost/mydatabase")
```

## Execute a BlendSQL Query

The `blend()` function is used to execute a BlendSQL query against a database and return the final result, in addition to the intermediate reasoning steps taken.
Expand Down

0 comments on commit 457f900

Please sign in to comment.