From 36b60cd298cca60260922b52660cf0b0ada02205 Mon Sep 17 00:00:00 2001 From: Andre Henriques Date: Sun, 8 Dec 2024 11:38:36 +0000 Subject: [PATCH] add readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..41db33d --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Unwritten Application + +## API + +### `PUT` /generate_random + +NO BODY + +Used to generate random data in the database. +Generates 10000 accounts and 1000000 transactions + +### `DELETE` /delete_data + +Used to delete the data from the database + +### `GET` /injest + +Injests the data from the database into polars LazyFrames + +Note: This should take around 1-2sec, I think that most of the delay comes from having to clone all the UUIDs into strings + +### `Get` /accounts + +Returns the text representaion of the accounts LazyFrame + +### `Get` /transactions + +Returns the text representaion of the transactions LazyFrame