From 2b7a3a815fb5d0b5155deec5f613730e898e4100 Mon Sep 17 00:00:00 2001 From: bpc2003 Date: Thu, 24 Apr 2025 17:08:08 -0400 Subject: Update Documentation --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8224360..9422802 100644 --- a/README.md +++ b/README.md @@ -43,20 +43,17 @@ if the file doesn't exist it will return an empty tablist array\ if readdb fails in any other way it will return NULL. - writedb: takes a filename and tablist array\ writedb writes the given tablist array to a file. -- getkeys: takes a tablist array and index\ -getkeys finds every single key-value pair in a given tablist\ -and returns an integer array with the indexes of each key-value pair. -- getkey: takes a tablist array, index, and key\ -getkey finds a key-value pair from a given tablist\ -if it can't find the key-value pair it will return an empty -tabidx. -- setkey: takes a pointer to a tablist array, an index, and a key-value pair\ -setkey sets a given key-value pair in a given object, if a given key already exists\ -it will overwrite the value set in that key.\ -If setkey is successful it will return 0. -- delkey: takes a tablist array, an index, and a key\ -delkey deletes the given key-value pair from the given object\ -if successful it will return 0. +- getkeys: takes a tablist array, id, list of keys,\ +and the length of the list of keys.\ +If id is -1, it will get every provided key from every document.\ +If keys is NULL, it will get every key-value pair from a document. +- setkeys: takes a tablist array, id, list of key-value pairs,\ +and the length of the list of pairs.\ +If id is -1, it will set the provided pairs in every document. +- delkeys: takes a tablist array, id, list of keys,\ +and the length of the list of keys.\ +If id is -1, it will delete every provided key from every document.\ +If keys is NULL it will delete every key from a document. ## Removal In order to remove mdb run:\ -- cgit v1.2.3