๐ข๏ธ The Athenna database handler for SQL/NoSQL.
Home Page: https://athenna.io
License: MIT License
The Athenna database handler for SQL/NoSQL.
For project documentation click here. If something is not clear in the documentation please open an issue in the documentation repository
If you want to contribute to this project, first read the CONTRIBUTING.MD file. It will be a pleasure to receive your help.
With ๐ by Athenna community
It would be very nice if we could remove the DB_AUTO_CONNECT env variable logic of the DatabaseProvider and auto connect the database driver when some operation is called.
This would help a lot in the performance of Artisan commands that does not use the database. Also, when the connection with database is not working, Artisan tries to auto connect to database because of DB_AUTO_CONNECT logic and fails.
The database would be connected this way:
DB.connection('postgres').isConnected() // false
await DB.connection('postgres')
.table('users')
.select('id')
.where('id', 1)
.findMany() // [...]
DB.connection('postgres').isConnected() // trueAdd methods like andWhere(), andWhereLike(), andHaving(), etc.
Facilitate the way to create queries.
No response
Commands that affect saved data, should be ignored in the production environment if it has no force flag.
The run/revert migration commands and database wipe command, should not be easily run in production, these commands could be found at the above paths of the project:
To prevent production data lost.
If NODE_ENV=production, the above command should throw an exception with an explanation to the developer that he needs to use --force flag to run this command in production:
node artisan migration:run If NODE_ENV=production, the above command should work as expected:
node artisan migration:run --forceThis command will be responsible to create an entire CRUD and implement the following:
Points to keep in mind:
Athenna needs to validate if @athenna/http exists to be able to create the controller, otherwise skip only the controller creation.
When running node artisan make:crud, Athenna needs to keep prompting the user
the columns and relations that he wants to add to his model, this data will be used
to craft all the templates.
Make it easy to create a full CRUD on Athenna.
No response
Implement the following annotations to be used in models:
@BeforeCreate()@AfterCreate()@BeforeUpdate()@AfterUpdate()@BeforeSave()@AfterSave()@BeforeDelete()@AfterDelete()@BeforeFind()@AfterFind()Give more control to the developer over database operations.
No response
Implement when method in QueryBuilder class.
Sometimes you may want certain query clauses to apply to a query based on another condition. For instance, you may only want to apply a where statement if a given input value is present on the incoming HTTP request. You may accomplish this using when method.
The when method only executes the given closure when the first argument is true. If the first argument is false, the closure will not be executed. So, in the example above, the closure given to when method will only be invoked if the role field is present on the incoming request and evaluates to true.
const role = request.payload('role')
await DB
.table('users')
.when(role, (query, role) => query.where('roleId', role))
.findMany()Implement events to be called before and after database operations.
These events are going to be very useful for making modifications in the payload before or after some database operations. We can have for example these:
beforeCreateafterCreatebeforeUpdateafterUpdatebeforeDeleteafterDeletebeforeSaveafterSavebeforeFindafterFindAll of before... methods should receive all the arguments used to call create, createMany, etc. This way, the developer can make changes in the payloads before executing his operation. If any of before... methods return null value, the database operation must be canceled.
All of after... methods should receive all the data returned by the database operation. This way, the developer can make changes in the return payloads before create and createMany return the value.
import { hash } from 'bcryptjs'
import { Is } from '@athenna/common'
import { Model } from '@athenna/database'
export class Flight extends Model {
/**
* Execute everytime before creating some value in database.
*
* @return {Promise<any>}
*/
static async beforeCreate(data) {
const executor = async (data) => {
data.password = await hash(data.password)
}
if (Is.Array(data)) {
data = await Promise.all(data.map(d => executor(d)))
return
}
await executor(data)
}
}Use Edge template engine to create artisan "make" commands instead of EJS.
The @athenna/mail package will use Edge template engine to write email templates. To keep the same pattern and behavior from @athenna/mail we are going to use the Edge template engine in Artisan make commands.
No response
4.1.0
Run node artisan configure @athenna/database
I expect to see all database commands configured in .athennarc.json
Commands like make:model are not configured in .athennarc.json.
No response
System:
OS: macOS 14.0
CPU: (8) arm64 Apple M1 Pro
Memory: 3.30 GB / 16.00 GB
Shell: 5.9 - /opt/homebrew/bin/zsh
Binaries:
Node: 21.1.0 - ~/.nvm/versions/node/v21.1.0/bin/node
Yarn: 1.22.19 - ~/.nvm/versions/node/v21.1.0/bin/yarn
npm: 10.2.0 - ~/.nvm/versions/node/v21.1.0/bin/npm
bun: 1.0.7 - ~/.bun/bin/bunThe version of this package needs to be updated to 3.0.0.
We are going to start versioning the Athenna packages using Semver. All packages of Athenna will be updated to version 3.0.0 to start following Semver rules.
No response
1.4.6
Just use the @athenna/cli to run the athenna install:database command.
I expect that when I want to use the @athenna/database to access only SQL databases, that Mongoose dependency is not installed. Also, I want to manage my own version of Mongoose and Knex in my project.
Mongoose and Knex are installed, no mater which type of database he selects using the install:database command.
No response
System:
OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
Memory: 6.19 GB / 15.03 GB
Container: Yes
Shell: 5.8 - /usr/bin/zsh
Binaries:
Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npmImplement having, havingRaw and havingBetween methods in QueryBuilder class.
Implement these methods to be easier to group stuffs using groupBy method.
No response
Implement latest and oldest methods in QueryBuilder class.
The latest and oldest methods will allow the developer to easily order results by date. By default, the result will be ordered by the table's createdAt column. Or, he may pass the column name that you wish to sort by.
await Database
.table('users')
.latest()
.findMany()
await Database
.table('users')
.oldest()
.findMany()
await Database
.table('users')
.latest('deletedAt')
.findMany()Implement the static getter attributes in models.
This getter will be responsible for setting default attributes for your model. He needs to be called in create, createMany and createOrUpdate methods before executing them.
If the value has been already set in the method signature, then we cannot override it using the attributes. These properties should only be used when the value does not exist in the payloads.
Implementation of attributes in the model:
import { Uuid } from '@athenna/common'
import { Model } from '@athenna/database'
export class Flight extends Model {
/**
* Set the default attributes of your model.
*
* @return {any}
*/
static get attributes() {
return {
id: Uuid.generate()
}
}
/*...*/
}Usage of attributes:
import { Flight } from '#app/Models/Flight'
const flight = await Flight.create()
console.log(flight.id) // -> 4b68c460-60f5-11ed-9b6a-0242ac120002attributes is implemented, but the developer is setting his own property in the method signature:
import { Flight } from '#app/Models/Flight'
// Setting my own id attribute
const flight = await Flight.create({ id: '299dabf8-60f4-11ed-9b6a-0242ac120002' })
console.log(flight.id) // -> 299dabf8-60f4-11ed-9b6a-0242ac1200023.0.9
Set protocol as undefined and try to connect in a Mongo database.
I expect to see some error of what happened.
The application exists without any information, for some reason, process.on('uncaughtException') and the global try catch of @athenna/core` are not catching the exception.
No response
System:
OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
Memory: 2.34 GB / 15.03 GB
Container: Yes
Shell: 5.8 - /usr/bin/zsh
Binaries:
Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npmImplementation of MongoDB Driver for database package.
Meet the needs of developers using the MongoDB database.
No response
This command will add some useful information about the state of a database model of an Athenna application.
node artisan model:showRefactor database package to use Knex query builder to create our own ORM.
We are having some limitations with TypeORM. Because of that, we are going to use Knex query builder to create our own ORM and implement this limitations.
No response
Implementation of SQLite Driver for database package.
Meet the needs of developers using the SQLite database.
No response
Implement the closeAll method in Database class.
This method will be responsible to close all the database connections opened in DriverFactory class.
await Database.closeAll()3.0.10
await User.create() or await User.create(undefined)
I expect that a default value is set because I could use the default values set inside the model.
An error is throw when trying to verify the primary key of the data.
No response
System:
OS: macOS 13.1
CPU: (8) arm64 Apple M1 Pro
Memory: 306.48 MB / 16.00 GB
Shell: 5.8 - /opt/homebrew/bin/zsh
Binaries:
Node: 16.13.1 - ~/.nvm/versions/node/v16.13.1/bin/node
npm: 8.1.2 - ~/.nvm/versions/node/v16.13.1/bin/npm1.5.0
Same as issue #44 of @athenna/logger but with multiple modules:
I expect that when I install the version 1.0.0 of the packages above, that @athenna/database package uses the same version.
Two versions of the packages are installed, specifics for @athenna/database and the other for the project. This means that I can't choose which version of the packages I want to use globally in the project.
No response
System:
OS: Linux 5.14 Ubuntu 20.04.5 LTS (Focal Fossa)
CPU: (8) x64 11th Gen Intel(R) Core(TM) i5-1145G7 @ 2.60GHz
Memory: 6.19 GB / 15.03 GB
Container: Yes
Shell: 5.8 - /usr/bin/zsh
Binaries:
Node: 16.18.0 - ~/.nvm/versions/node/v16.18.0/bin/node
npm: 8.19.2 - ~/.nvm/versions/node/v16.18.0/bin/npm
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google โค๏ธ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.