An extremely minimal implementation of some database functionality for educational purposes consisting of only one php-file! Mimics some commands used with MongoDB, but uses single json-files as collections.
Not to be used for anything else but education...!
Simply copy the script file 'index.php' into a folder for your database on your server running php. Make sure it has the rights to create, delete and change files on your server.
The following table shows how to get MingiDB running and do some CRUD operations (Create, Read, Update, Delete) using MingiDB via the browser address bar. You can also use the example client to do the same and more via a clickable interface and asynchronous communication with fetch. Feel free to clone this repo with MingiDB and the client to start the creation of your own project from there.
| # | action | expected result |
|---|---|---|
| 1 | Get access to your server running php5 or above, for example via ftp | You see the directory structure of your server |
| 2 | Create a folder on your server named Database |
The folder Database appears |
| 3 | Copy the file index.php to the folder |
The file appears inside the folder |
| 4 | In a browser, enter the http-Address of your server followed by Database/ |
The page shows {"status":"failure","data":"no collection specified"}, which means that MingiDB runs and answers |
| 5 | Extend the address with the query string ?command=show |
The page shows {"status":"success","data":[]}, which means that MingiDB successfully retrieved the information that no collections exist |
| 6 | Change the query string to ?command=create&collection=Students |
The page shows {"status":"success"}. Check the folder, there is now a file Students.json with a size of 0, since it's empty |
| 7 | Add a document to the collection by typing ?command=insert&collection=Students&data={"name":"Doe","firstname":"John","age":21,"passed":true} |
The page shows {"status":"success","data":{"id":"626c2b283432c"}}, where the id most likely differs in this example. View the contents of the file Students.json, it shows the data you inserted. |
| 8 | Add another document to the collection by typing ?command=insert&collection=Students&data={"name":"Doe","firstname":"Mary","age":20,"passed":false} |
The page shows another success-message and Mary was added to the file Students.json |
| 9 | Type ?command=find&collection=Students |
The page shows success and all documents stored in Students.json |
| 10 | Type ?command=find&collection=Students&data={"name":"Doe"} |
The page shows success and again all documents, since Mary and John share the same family name |
| 11 | Type ?command=find&collection=Students&data={"age":22} |
The page shows {"status":"success","data":[]}. No documents were retrieved, since there is no student at age 22 |
| 12 | Type ?command=find&collection=Students&data={"passed":true} |
The page shows John's document, since Mary has not passed (e.g. her exam) yet |
| 13 | Type ?command=find&collection=Students&id=... but replace the dots with the id of Mary's document |
The page shows Mary's document |
| 14 | Type ?command=update&collection=Students&id=...&data={"passed":true}, but replace the dots with the id of Mary's document |
The page shows the updated document with Mary being passed. Check the file too! |
| 15 | Type ?command=delete&collection=Students&id=..., but replace the dots with the id of Mary's document |
The page shows success. Check the file to verify, that John is all by himself again |
| 16 | Type ?command=show again |
The page shows that there is one collection called Students in the database |
| 17 | Type ?command=drop&collection=Students |
The page shows success, check the folder Database to verify, that the file Students.json was deleted. |
| 18 | Type ?command=show again |
same as #5 |
Send commands and data as get-parameters. The structure is
https://UrlOfYourDatabaseFolder/?command=...&collection=...&id=...&data={DataInJsonFormat}
where not all parts of the query must be present at all times and the pascal-case parts like the dots need to be replaced by your information.
The script returns a Json-string in the following format
{'status':..., 'data':{...}}
where status takes on the values "success" or "failure" and data contains a Json-string with the results or an error message.
command=create&collection=NameOfCollection
command=drop&collection=NameOfCollection
command=show
command=insert&collection=NameOfCollection&data={KeyValuePairs}
command=delete&collection=NameOfCollection&id=IdOfTheDocument
where id was created by the script and needs to be retrieved first
command=find&collection=NameOfCollection&id=IdOfTheDocument
retrieves the document with the given id, or
command=find&collection=NameOfCollection&data={KeyValuePairs}
where data contains a filter. Only the documents matching the filter will be retrieved. If data is the empty filter {}, all documents of the collection are retrieved.
command=update&collection=NameOfCollection&id=IdOfTheDocument&data={KeyValuePairs}
where data contains the values to change to at the given key within the document specified by id.