Home

Welcome to the Simple_Database wiki!

Collection of Classes and Functions

class: establish_db()

Parameters:
db_name: str

To initialize a Database you have to give it a name or, if a database already exists, provide a name.
🛑 Normally not used standalone, it inherits to the other classes! 🛑

Excample:

db = establish_db("expml") 

Functions

• close()

Just use the "close" tag on the database clase to close this connection

Excample:

db = establish_db("expml")
#some code db.close() 

class: generate_db()

Parameters:
db_name: str

This class is used to build up a database. Fill it with tables or delete tables. It inherits from "establish_db" so it also needs the database name to generate a database or open a connection.

Excample:

db = generate_db("expml")

Functions

• add_table()

Parameters:
tbl_name: str
col: dict

Return:
bool

Adding tables to your database by giving it a name and the column information. The dict for the column information ist structured like this:

"col_name": {
"primarykey": bool,
"autoincrement": bool,
"type": DATATYPEasSTRING,
"mandatory": bool,
"foreignkey": (
bool,
{
"table": REFERENCE_TABLENAMEasSTRING,
"column": REFERENCE_COLUMNNAMEasSTRING
}
)
},

Excample:

db = generate_db("expml")
db.add_table(
"Test", {
"ID": {
"primarykey": True,
"autoincrement": True,
"type": "INTEGER",
"mandatory": False,
"foreignkey": (
False,
{
"table": "",
"column": ""
}
)
},
"Title": {
"primarykey": False,
"autoincrement": False,
"type": "CHAR(20)",
"mandatory": True,
"foreignkey": (
False,
{
"table": "",
"column": ""
}
)
},
"Name": {
"primarykey": False,
"autoincrement": False,
"type": "TEXT",
"mandatory": True,
"foreignkey": (
False,
{
"table": "",
"column": ""
}
)
},
"Age": {
"primarykey": False,
"autoincrement": False,
"type": "INTEGER",
"mandatory": False,
"foreignkey": (
False,
{
"table": "",
"column": ""
}
)
}
}
)
db.close()

• remove_table()

Parameters:
tbl_name: str

Return:
bool

This will remove a table of the database by its given name.

IMPORTANT: It will delete the table no matter what! Watch out if it has foreign relations

Will return true if deletion was successful

Excample:

db = generate_db("expml")
db.remove_table(tbl_name: str)
db.close()

class: operate_db()

Parameters:
db_name: str

This class is used to operate a database. You can add, del, get and search content in a database

Excample:

db = operate_db("expml")

Functions

• add_content()

Parameters:
tbl_name: strcntnt: dict | list[dict]
with_foreign_key: bool | tuple -> defaults to false

You can add single lines of data or add a whole batch of data as a list. With the foreign key parameter you can give it a table and the key that should be added. It tests if the key exists in the destination table.

Excample 1 (Single Data):

# DB is already initialized and table "Users" is added
data1 = {'Name': 'John', 'Age': 30}
db.add_content('Users', data1)

Excample 2 (Batch Data):

# DB is already initialized and table "Users" is added
data2 = [{'Name': 'John', 'Age': 30},
{'Name': 'Sarah', 'Age': 27},
{'Name': 'Genji', 'Age': 35}]
db.add_content('Users', data1)

Excample 3 (Foreign key):

# DB is already initialized and table "Users" & "Department" are added.
# The Department ID 423 is also already added
data3 = {'Name': 'John', 'Age': 30}
db.add_content('Users', data1, ("Department" {"DID": 423}))
db.close()

• update_content()

Parameters:
tbl_name: strsearch: dictcntnt: dict | dict

You can update datasets by searching for it and then fill the new information.

Excample 1:

# DB is already initialized and table "Users" is added.
# The database has a dataset with the id 456 and a current name of "bob"
tbl = "users"
dataset2update = {"id": 456}
data2update = {"name": "john"}
db.update_content(tbl, dataset2update, data2update)
# Now the dataset with the id 465 should have the name "john" and not "bob" anymore

• del_content()

Parameters:
tbl_name: strsearch: dict

You can remove content with this function by searching for attributes. All datasets that will be found are going to be deleted.

IMPORTANT: There is no confirmation. If it finds something it deletes it.

Excample:

# DB is already initialized and table "Users" is added.
# The Dataset for the name "Bob" is added.
data2delete = {'name': 'Bob'}
db.del_content('Users', data2delete)
# Now all Data where the name was "Bob" has been deleted!

• get_content()

Parameters:
tbl_name: str

Returns:
list

With this you get all the data from a specific table.

Excample:

# DB is already initialized and table "Users" is added.
# The Database is filled with data
data = db.get_content('Users')
print(data)
# Now all Data will be printed

• search_table()

Parameters:
tbl_name: strsearch: dict

Returns:
list

You can search for specific datasets and all the found data will be returned as list

Excample:

# DB is already initialized and table "Users" is added.
# The Database is filled with data
data2search = {'name': 'Bob'}
found_data = db.search_content('Users', data2search)
print(found_data)
# Now all Datasets with the name "Bob" will be printed