Download the PHP package koolreport/querybuilder without Composer
On this page you can find all versions of the php package koolreport/querybuilder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download koolreport/querybuilder
More information about koolreport/querybuilder
Files in koolreport/querybuilder
Package querybuilder
Short Description Create query by php code
License MIT
Homepage https://www.koolreport.com
Informations about the package querybuilder
Introduction
QueryBuilder
helps you to generate SQL Query using pure PHP code. The benefits of using this package are:
- To create faster, better and more precise SQL query without any syntax error.
- To overcome to complexity of SQL even if you are expert.
- To prevent your data from security risks such as sql injection.
If you are familiar with Laravel
, an famous PHP Framework, you will like this package very much because you will not need to learn how to use this package.
Installation
By downloading .zip file
- Download
- Unzip the zip file
- Copy the folder
querybuilder
intokoolreport
folder so that look like below
By composer
Documentation
Generate compatible SQL query for different database systems
QueryBuilder
package support MySQL
, PostgreSQL
, SQLServer
query type.
MySQL Query
Use may cover your query in MySQL::type()
function to get SQL in string or use toMySQL()
of the query.
PostgreSQL Query
Use may cover your query in PostgreSQL::type()
function to get SQL in string or use toPostgreSQL()
of the query.
SQLServer Query
Use may cover your query in SQLServer::type()
function to get SQL in string or use toSQLServer()
of the query.
Parameterized Query and Parameters (version >= 3.0.0)
When you build a query builder with data from untrusted source (says, user inputs) it's dangerous to use the query builder's generated query directly because of possible SQL injection attack. In those cases it's advisable to get the query builder's generated parameterized query together with parameters and use them to get data instead:
Set Schemas
For security and authentication reasons users could set a query builder's schemas so that only tables and fields from those schemas are included in its generated queries:
Retrieving Results
Retrieving All Rows From A Table
You may use the table
method on the DB
facade to begin a query. The table
method returns a fluent query builder instance for the given table, allowing you to chain more constraints onto the query.
Retrieving A Single Row
If you just need to retrieve a single row from the database table, you may use the first
method.
Aggregates
The query builder also provides a variety of aggregate methods such as count
, max
, min
, avg
, and sum
. You may call any of these methods after constructing your query:
Sub query table
QueryBuilder
support creating sub query. Meaning that you can query from a table generated by another query.
Above will generate:
Selects
Specifying A Select Clause
Of course, you may not always want to select all columns from a database table. Using the select
method, you can specify a custom select
clause for the query:
To change name of column, you may use alias
function
The distinct
method allows you to force the query to return distinct results:
If you already have a query builder instance and you wish to add a column to its existing select clause, you may use the addSelect
method or simple use continuously select
method:
Raw Expressions
Sometimes you may need to use a raw expression in a query.
selectRaw
The selectRaw
method can be used to create raw select. This method accepts an optional array of bindings as its second argument:
whereRaw / orWhereRaw
The whereRaw
and orWhereRaw
methods can be used to inject a raw where
clause into your query. These methods accept an optional array of bindings as their second argument:
havingRaw / orHavingRaw
The havingRaw
and orHavingRaw
methods may be used to set a raw string as the value of the having
clause:
orderByRaw
The orderByRaw
method may be used to set a raw string as the value of the order
by clause:
Joins
Inner Join Clause
The query builder may also be used to write join statements. To perform a basic "inner join", you may use the join
method or innerJoin
on a query builder instance. The first argument passed to the join
method is the name of the table you need to join to, while the remaining arguments specify the column constraints for the join. Of course, as you can see, you can join to multiple tables in a single query:
leftJoin/rightJoin/outerJoin
crossJoin
To perform a "cross join" use the crossJoin
method with the name of the table you wish to cross join to. Cross joins generate a cartesian product between the first table and the joined table:
Advanced Join Clauses
You may also specify more advanced join clauses. To get started, pass a Closure
as the second argument into the join
method. The Closure
will receive a JoinClause
object which allows you to specify constraints on the join
clause:
If you would like to use a "where" style clause on your joins, you may use the where
and orWhere
methods on a join. Instead of comparing two columns, these methods will compare the column against a value:
Unions
The query builder also provides a quick way to "union" two queries together. For example, you may create an initial query and use the union method to union
it with a second query:
Where Clauses
Simple Where Clauses
You may use the where
method on a query builder instance to add where
clauses to the query. The most basic call to where
requires three arguments. The first argument is the name of the column. The second argument is an operator, which can be any of the database's supported operators. Finally, the third argument is the value to evaluate against the column.
For example, here is a query that verifies the value of the "votes" column is equal to 100:
For convenience, if you simply want to verify that a column is equal to a given value, you may pass the value directly as the second argument to the where
method:
Of course, you may use a variety of other operators when writing a where
clause:
You may also pass an array of conditions to the where
function:
Or Statements
You may chain where constraints together as well as add or clauses to the query. The orWhere
method accepts the same arguments as the where
method:
Brackets in where
You could add opening and closing brackets to where clause with whereOpenBracket
and whereCloseBracket
methods:
These brackets can work for multiple levels of where conditions.
Additional Where Clauses
whereBetween
The whereBetween
method verifies that a column's value is between two values:
whereNotBetween
The whereNotBetween
method verifies that a column's value lies outside of two values:
whereIn / whereNotIn
The whereIn
method verifies that a given column's value is contained within the given array:
The whereNotIn
method verifies that the given column's value is not contained in the given array:
whereNull / whereNotNull
The whereNull
method verifies that the value of the given column is NULL
:
The whereNotNull
method verifies that the column's value is not NULL
:
whereDate / whereMonth / whereDay / whereYear / whereTime
The whereDate
method may be used to compare a column's value against a date:
The whereMonth
method may be used to compare a column's value against a specific month of a year:
The whereDay
method may be used to compare a column's value against a specific day of a month:
The whereYear
method may be used to compare a column's value against a specific year:
The whereTime
method may be used to compare a column's value against a specific time:
whereColumn
The whereColumn
method may be used to verify that two columns are equal:
You may also pass a comparison operator to the method:
The whereColumn
method can also be passed an array of multiple conditions. These conditions will be joined using the and
operator:
Parameter Grouping
Sometimes you may need to create more advanced where clauses such as "where exists" clauses or nested parameter groupings. The KoolReport query builder can handle these as well. To get started, let's look at an example of grouping constraints within parenthesis:
As you can see, passing a Closure
into the orWhere
method instructs the query builder to begin a constraint group. The Closure
will receive a query builder instance which you can use to set the constraints that should be contained within the parenthesis group. The example above will produce the following SQL:
Where Exists Clauses
The whereExists
method allows you to write where exists
SQL clauses. The whereExists
method accepts a Closure
argument, which will receive a query builder instance allowing you to define the query that should be placed inside of the "exists" clause:
The query above will produce the following SQL:
JSON Where Clauses
QueryBuilder
package also supports querying JSON column types on databases that provide support for JSON column types. Currently, this includes MySQL 5.7 and PostgreSQL. To query a JSON column, use the ->
operator:
Ordering, Grouping, Limit, & Offset
orderBy
The orderBy
method allows you to sort the result of the query by a given column. The first argument to the orderBy
method should be the column you wish to sort by, while the second argument controls the direction of the sort and may be either asc
or desc
:
latest / oldest
The latest
and oldest
methods allow you to easily order results by date. By default, result will be ordered by the created_at
column. Or, you may pass the column name that you wish to sort by:
groupBy / having
The groupBy
and having
methods may be used to group the query results. The having
method's signature is similar to that of the where
method:
You may pass multiple arguments to the groupBy
method to group by multiple columns:
For more advanced having
statements, see the havingRaw
method.
skip / take
To limit the number of results returned from the query, or to skip a given number of results in the query, you may use the skip
and take
methods:
Alternatively, you may use the limit
and offset
methods:
Conditional Clauses
when
Sometimes you may want clauses to apply to a query only when something else is true. For instance you may only want to apply a where
statement if a given input value is present on the incoming request. You may accomplish this using the when
method:
The when
method only executes the given Closure when the first parameter is true
. If the first parameter is false
, the Closure will not be executed.
You may pass another Closure as the third parameter to the when
method. This Closure will execute if the first parameter evaluates as false
. To illustrate how this feature may be used, we will use it to configure the default sorting of a query:
branch
Sometime you may need clause to apply to query when a parameter has specific value, you may use the branch
statement.
You will pass to the branch
function the list of Closure
in second parameters.
Inserts
Although working with KoolReport, most of the time you will deal with select
statement, the query builder also provides an insert
method for inserting records into the database table. The insert
method accepts an array of column names and values:
You may even insert several records into the table with a single call to insert
by passing an array of arrays. Each array represents a row to be inserted into the table:
Updates
Although working with KoolReport, most of the time you will deal with select
statement, the query builder can also update
existing records using the update
method. The update
method, like the insert
method, accepts an array of column and value pairs containing the columns to be updated. You may constrain the update
query using where
clauses:
Increment & Decrement
The query builder also provides convenient methods for incrementing or decrementing the value of a given column. This is a shortcut, providing a more expressive and terse interface compared to manually writing the update
statement.
Both of these methods accept at least one argument: the column to modify. A second argument may optionally be passed to control the amount by which the column should be incremented or decremented:
Deletes
Although working with KoolReport, most of the time you will deal with select
statement,the query builder may also be used to delete
records from the table via the delete
method. You may constrain delete
statements by adding where
clauses before calling the delete
method:
If you wish to truncate the entire table, which will remove all rows and reset the auto-incrementing ID to zero, you may use the truncate
method:
Pessimistic Locking
The query builder also includes a few functions to help you do "pessimistic locking" on your select
statements. To run the statement with a "shared lock", you may use the sharedLock
method on a query. A shared lock prevents the selected rows from being modified until your transaction commits:
Alternatively, you may use the lockForUpdate
method. A "for update" lock prevents the rows from being modified or from being selected with another shared lock:
Support
Please use our forum if you need support, by this way other people can benefit as well. If the support request need privacy, you may send email to us at [email protected].