beardb 0.0.2

Database system implementing encrypted versions JSON of data. Easy to access, manage and deploy remotely

bearDB

Database system implementing AES encrypted versions JSON of data. Easy to access, manage and deploy remotely

Web Documentation

Database Architecture

Project
 -Database
   -Bucket
      -Data

Outline

• Install Libraries
• Import Libraries
• Initialize Project
• Insert Data into Bucket
• Fetch Data From ID
• Fetch Data From Query
• Updata Data in Bucket From Query
• Update Data From Bucket From ID
• Delete Data From Bucket From Query
• Working With BeardbAPI

Install Libraries

$ python3 -m pip install bearDB

Import Libraries

from beardb import Beardb
from beardb import Bucket

Initialize Project

project = Beardb('projectname')
project.load_database('class') 

Initialize Bucket(DataBase File)

users = Bucket(project=project, bucket_name='users') # Project variable defined in the initialization 

Insert Data into Bucket

data = {
       'name':'Teddy Oweh',
       'Random Data':'Golf'
}
users.insert(data=data)
 

Fetch Data From ID

userinfo = users.fetchbyID(id="ae0ca44e-5301-11ed-8d24-a6bd5a94b3a6")

Fetch Data From Query

query= {
       'name':'Teddy Oweh',
       'Random Data':'Golf'
}
userinfo = users.fetchData(query=query)

Updata Data in Bucket From Query

query= {
       'name':'Teddy Oweh',
       'Random Data':'Golf'
}
newdata = {
       'name':'Teddy Oweh',
       'Random Data':'Ping Pong',
       'Added Data':'College'
       
}

users.update(query=query,data=newdata)

Update Data From Bucket From ID

  
newdata = {
       'name':'Teddy Oweh',
       'Random Data':'Ping Pong',
       'Added Data':'College'
       
}

users.updatebyId(id='ae0ca44e-5301-11ed-8d24-a6bd5a94b3a6',data=newdata})

Delete Data From Bucket From Query

query= {
       'name':'Teddy Oweh',
       'Random Data':'Golf'
}
 

users.delete(query=query})
 

Delete Data From Bucket From ID

users.deletebyId(id="ae0ca44e-5301-11ed-8d24-a6bd5a94b3a6")


### Test Code
```py
beardb_ = Beardb('projects')
beardb_.load_database('computers')
computers=Bucket(beardb_,'computers')
computers.insert({'model':'lenovo','ram':'8gb','hdd':'1tb','processor':'i5'})

Working with BeardbAPI

In Order to communicate with the microservice beardbAPI deploys when launched. This client Library consumes APIs effienctly and returns the data and status code.

Outline

• Import Library
• Initialize Client Object
• Get User Data
• Create New Project
• Create New Database
• Create New Bucket
• Insert Data
• Fetch Data by Query
• Fetch Data by ID
• Update Data by Query
• Update Data by ID
• Delete Data by Query
• Delete Data by ID
• Get Buckets
• Get Databases
• Get Projects

Importing Library

from beardb import Client

Initialize Client Object

Whenever a new user is created, is always returns the secret to be able to access the data.

host='127.0.0.1'
port=5555
email='[e-mail]'
secret='3687065edf2fdc64bbeb8cdac409ac352fdb65f01423159842d19283309cb70c'
client = Client(
                host=host,
                port=port,
                email=email,
                secret=secret
              )           

Get User Data

cient.mydata()

Create New User

email='[e-mail]'
password='myrealpassword'
fullname='Teddy Oweh'

client.createnewuser(
                     fullname=fullname
                     email=email
                     password=password
)

Create New Project

project='TestProject'
client.createnewproject(
                       project=project
)

Create New Database

project='TestProject'
database='TestDatabase'
client.createnewdatabase(
                         project=project,
                         database=database
)   

Create New Bucket

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
client.createnewbucket(
                         project=project,
                         database=database,
                         bucket=bucket
)   

Insert Data

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
data={'name':'teddy',age:1}
client.insertdata(
                         project=project,
                         database=database,
                         bucket=bucket
)   

Fetch Data by Query

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
query={'name':'teddy',age:1}
client.fetchdata(
                         project=project,
                         database=database,
                         bucket=bucket,
                         query=query
)   

Fetch Data by ID

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
id='b419840a-7e04-11ed-84f8-324d38bf6d75'
client.fetchBYID(
                         project=project,
                         database=database,
                         bucket=bucket,
                         id=id
)   

Update Data by Query

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
data={'name':'teddy',age:1}
query='{name':'teddy'}
client.updatedata(
                         project=project,
                         database=database,
                         bucket=bucket,
                         data=data,
                         query=query
)   

Update Data by ID

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
data={'name':'teddy',age:1}
id='b419840a-7e04-11ed-84f8-324d38bf6d75'
client.updatebyid(
                         project=project,
                         database=database,
                         bucket=bucket,
                         data=data,
                         id=id
)   

Delete Data by Query

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
query={'name':'teddy',age:1}
client.deletedata(
                         project=project,
                         database=database,
                         bucket=bucket,
                         query=query
)   

Delete Data by ID

project='TestProject'
database='TestDatabase'
bucket='TestBucket'
id='b419840a-7e04-11ed-84f8-324d38bf6d75'
client.deletebyid(
                         project=project,
                         database=database,
                         bucket=bucket,
                         id=id
)   

Get Buckets

client.getbuckets()

Get Databases

client.getdatabases()

Get Projects

cient.getprojects()

License

MIT License

Copyright (c) 2022 Teddy Oweh

teddyoweh built it di