Skip to content

Commit 1afbf6c

Browse files
committed
chores: 1.3 release
Signed-off-by: Emanuel Calvo <3manuek@gmail.com>
1 parent 31a2a6b commit 1afbf6c

File tree

3 files changed

+32
-9
lines changed

3 files changed

+32
-9
lines changed

CHANGELOG.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@
22

33
Notable changes to pgqueries.
44

5-
## Release number - [yyyy-mm-dd]
5+
## v1.3 - [2023-06-14]
66

77
### Added
88

9-
### Changed
9+
- artifact_builder builds NDJSON format, for easy import into Postgres using COPY command.
10+
### Fixed
1011

11-
### Fixed
12+
- Fixes to the artifact_builder
13+
14+
## v1.0 - v1.2
15+
16+
### Added
17+
18+
- Functional artifact_builder

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ The hierarchical tree is compound by:
3030
sql/<category>/file.[sql|md]
3131
```
3232

33-
34-
3533
## SQL formatting and practices
3634

3735
Rule 1:
@@ -44,6 +42,13 @@ Rule 2:
4442

4543
> First comment line is mandatory. Minimal accepted documentation.
4644
45+
## Indexer
46+
47+
> This is currently under development.
48+
49+
This repository includes and indexer tool (artifact_builder) that builds json artifacts to be
50+
easily imported into Postgres using NDJSON format.
51+
4752
## Testing
4853

4954
TODO

artifact_builder/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,25 @@ This section builds a JSON map of the SQL and MD files present on the repository
44

55
## Execution
66

7+
Load virtual env:
78

89
```bash
9-
python3 artifact_builder/ -D sql -v | jq '.search_query'
10+
python3 -m venv venv
11+
source venv/bin/activate
12+
pip3 install -r requirements.txt
1013
```
1114

12-
Default output: index.json (with `--output`).
15+
The folowing allows you to index and search:
16+
17+
```bash
18+
python3 artifact_builder/ -D sql -E -v | jq '.search_query'
19+
```
20+
21+
See `python3 artifact_builder/ -h` for more information.
22+
23+
Default output: index.json (with `--output`) and `--ouput-ndjson` (`ndindex.json`).
1324

1425

15-
## Modules [potentially] used
26+
## TODO
1627

17-
[Dataclasses](https://github.com/lidatong/dataclasses-json)
28+
Modules [potentially] beneficial: [Dataclasses](https://github.com/lidatong/dataclasses-json)

0 commit comments

Comments
 (0)