Skip to content

Commit a2ea189

Browse files
go-jetgo-jet
committed
Go fmt.
1 parent 4e1ff65 commit a2ea189

17 files changed

+44
-43
lines changed

‎doc.go

+17-13
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,45 @@ Package jet is a complete solution for efficient and high performance database a
33
with code generation and automatic query result data mapping.
44
Jet currently supports PostgreSQL, MySQL, MariaDB and SQLite. Future releases will add support for additional databases.
55
6-
7-
Installation
8-
6+
# Installation
97
108
Use the command bellow to add jet as a dependency into go.mod project:
9+
1110
$ go get -u github.com/go-jet/jet/v2
1211
1312
Jet generator can be installed in one of the following ways:
1413
15-
1) (Go1.16+) Install jet generator using go install:
16-
go install github.com/go-jet/jet/v2/cmd/jet@latest
14+
1. (Go1.16+) Install jet generator using go install:
15+
go install github.com/go-jet/jet/v2/cmd/jet@latest
1716
18-
2) Install jet generator to GOPATH/bin folder:
19-
cd $GOPATH/src/ && GO111MODULE=off go get -u github.com/go-jet/jet/cmd/jet
17+
2. Install jet generator to GOPATH/bin folder:
18+
cd $GOPATH/src/ && GO111MODULE=off go get -u github.com/go-jet/jet/cmd/jet
2019
21-
3) Install jet generator into specific folder:
22-
git clone https://github.com/go-jet/jet.git
23-
cd jet && go build -o dir_path ./cmd/jet
20+
3. Install jet generator into specific folder:
21+
git clone https://github.com/go-jet/jet.git
22+
cd jet && go build -o dir_path ./cmd/jet
2423
2524
Make sure that the destination folder is added to the PATH environment variable.
2625
27-
28-
Usage
29-
26+
# Usage
3027
3128
Jet requires already defined database schema(with tables, enums etc), so that jet generator can generate SQL Builder
3229
and Model files. File generation is very fast, and can be added as every pre-build step.
3330
Sample command:
31+
3432
jet -dsn=postgresql://user:pass@localhost:5432/jetdb -schema=dvds -path=./.gen
3533
3634
Before we can write SQL queries in Go, we need to import generated SQL builder and model types:
35+
3736
import . "some_path/.gen/jetdb/dvds/table"
3837
import "some_path/.gen/jetdb/dvds/model"
3938
4039
To write postgres SQL queries we import:
40+
4141
. "github.com/go-jet/jet/v2/postgres" // Dot import is used so that Go code resemble as much as native SQL. It is not mandatory.
4242
4343
Then we can write the SQL query:
44+
4445
// sub-query
4546
rRatingFilms :=
4647
SELECT(
@@ -72,6 +73,7 @@ Then we can write the SQL query:
7273
)
7374
7475
Now we can run the statement and store the result into desired destination:
76+
7577
var dest []struct {
7678
model.Film
7779
@@ -81,9 +83,11 @@ Now we can run the statement and store the result into desired destination:
8183
err := stmt.Query(db, &dest)
8284
8385
We can print a statement to see SQL query and arguments sent to postgres server:
86+
8487
fmt.Println(stmt.Sql())
8588
8689
Output:
90+
8791
SELECT "rFilms"."film.film_id" AS "film.film_id",
8892
"rFilms"."film.title" AS "film.title",
8993
"rFilms"."film.rating" AS "film.rating",

‎internal/jet/bool_expression.go

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package jet
22

3-
//BoolExpression interface
3+
// BoolExpression interface
44
type BoolExpression interface {
55
Expression
66

@@ -84,22 +84,18 @@ func (b *boolInterfaceImpl) IS_NOT_UNKNOWN() BoolExpression {
8484
return newPostfixBoolOperatorExpression(b.parent, "IS NOT UNKNOWN")
8585
}
8686

87-
//---------------------------------------------------//
8887
func newBinaryBoolOperatorExpression(lhs, rhs Expression, operator string, additionalParams ...Expression) BoolExpression {
8988
return BoolExp(NewBinaryOperatorExpression(lhs, rhs, operator, additionalParams...))
9089
}
9190

92-
//---------------------------------------------------//
9391
func newPrefixBoolOperatorExpression(expression Expression, operator string) BoolExpression {
9492
return BoolExp(newPrefixOperatorExpression(expression, operator))
9593
}
9694

97-
//---------------------------------------------------//
9895
func newPostfixBoolOperatorExpression(expression Expression, operator string) BoolExpression {
9996
return BoolExp(newPostfixOperatorExpression(expression, operator))
10097
}
10198

102-
//---------------------------------------------------//
10399
type boolExpressionWrapper struct {
104100
boolInterfaceImpl
105101
Expression

‎internal/jet/column_list.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ package jet
44
type ColumnList []ColumnExpression
55

66
// SET creates column assigment for each column in column list. expression should be created by ROW function
7-
// Link.UPDATE().
8-
// SET(Link.MutableColumns.SET(ROW(String("github.com"), Bool(false))).
9-
// WHERE(Link.ID.EQ(Int(0)))
107
//
8+
// Link.UPDATE().
9+
// SET(Link.MutableColumns.SET(ROW(String("github.com"), Bool(false))).
10+
// WHERE(Link.ID.EQ(Int(0)))
1111
func (cl ColumnList) SET(expression Expression) ColumnAssigment {
1212
return columnAssigmentImpl{
1313
column: cl,
@@ -16,8 +16,8 @@ func (cl ColumnList) SET(expression Expression) ColumnAssigment {
1616
}
1717

1818
// Except will create new column list in which columns contained in list of excluded column names are removed
19-
// Address.AllColumns.Except(Address.PostalCode, Address.Phone)
2019
//
20+
// Address.AllColumns.Except(Address.PostalCode, Address.Phone)
2121
func (cl ColumnList) Except(excludedColumns ...Column) ColumnList {
2222
excludedColumnList := UnwidColumnList(excludedColumns)
2323
excludedColumnNames := map[string]bool{}

‎internal/jet/float_expression.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
package jet
22

3-
//FloatExpression is interface for SQL float columns
3+
// FloatExpression is interface for SQL float columns
44
type FloatExpression interface {
55
Expression
66
numericExpression

‎internal/jet/integer_expression.go

-3
Original file line numberDiff line numberDiff line change
@@ -120,17 +120,14 @@ func (i *integerInterfaceImpl) BIT_SHIFT_RIGHT(intExpression IntegerExpression)
120120
return newBinaryIntegerOperatorExpression(i.parent, intExpression, ">>")
121121
}
122122

123-
//---------------------------------------------------//
124123
func newBinaryIntegerOperatorExpression(lhs, rhs IntegerExpression, operator string) IntegerExpression {
125124
return IntExp(NewBinaryOperatorExpression(lhs, rhs, operator))
126125
}
127126

128-
//---------------------------------------------------//
129127
func newPrefixIntegerOperatorExpression(expression IntegerExpression, operator string) IntegerExpression {
130128
return IntExp(newPrefixOperatorExpression(expression, operator))
131129
}
132130

133-
//---------------------------------------------------//
134131
type integerExpressionWrapper struct {
135132
integerInterfaceImpl
136133

‎internal/jet/literal_expression.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ func Uint64(value uint64) IntegerExpression {
118118
return intLiteral(value)
119119
}
120120

121-
//---------------------------------------------------//
121+
// ---------------------------------------------------//
122122
type boolLiteralExpression struct {
123123
boolInterfaceImpl
124124
literalExpressionImpl
@@ -134,7 +134,7 @@ func Bool(value bool) BoolExpression {
134134
return &boolLiteralExpression
135135
}
136136

137-
//---------------------------------------------------//
137+
// ---------------------------------------------------//
138138
type floatLiteral struct {
139139
floatInterfaceImpl
140140
literalExpressionImpl
@@ -160,7 +160,7 @@ func Decimal(value string) FloatExpression {
160160
return &floatLiteral
161161
}
162162

163-
//---------------------------------------------------//
163+
// ---------------------------------------------------//
164164
type stringLiteral struct {
165165
stringInterfaceImpl
166166
literalExpressionImpl
@@ -351,7 +351,7 @@ func (n *nullLiteral) serialize(statement StatementType, out *SQLBuilder, option
351351
out.WriteString("NULL")
352352
}
353353

354-
//--------------------------------------------------//
354+
// --------------------------------------------------//
355355
type starLiteral struct {
356356
ExpressionInterfaceImpl
357357
}

‎internal/jet/statement.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
"time"
88
)
99

10-
//Statement is common interface for all statements(SELECT, INSERT, UPDATE, DELETE, LOCK)
10+
// Statement is common interface for all statements(SELECT, INSERT, UPDATE, DELETE, LOCK)
1111
type Statement interface {
1212
// Sql returns parametrized sql query with list of arguments.
1313
Sql() (query string, args []interface{})

‎internal/jet/string_expression.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func (s *stringInterfaceImpl) NOT_REGEXP_LIKE(pattern StringExpression, caseSens
8989
return newBinaryBoolOperatorExpression(s.parent, pattern, StringNotRegexpLikeOperator, Bool(len(caseSensitive) > 0 && caseSensitive[0]))
9090
}
9191

92-
//---------------------------------------------------//
92+
// ---------------------------------------------------//
9393
func newBinaryStringOperatorExpression(lhs, rhs Expression, operator string) StringExpression {
9494
return StringExp(NewBinaryOperatorExpression(lhs, rhs, operator))
9595
}

‎mysql/cast.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (c *castImpl) AS_CHAR(length ...int) StringExpression {
6868
return StringExp(c.AS("CHAR"))
6969
}
7070

71-
// AS_DATE casts expression AS DATE type
71+
// AS_DATE casts expression AS DATE type
7272
func (c *castImpl) AS_DATE() DateExpression {
7373
return DateExp(c.AS("DATE"))
7474
}

‎mysql/functions.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,8 @@ var REGEXP_LIKE = jet.REGEXP_LIKE
225225
//----------------- Date/Time Functions and Operators ------------//
226226

227227
// EXTRACT function retrieves subfields such as year or hour from date/time values
228-
// EXTRACT(DAY, User.CreatedAt)
228+
//
229+
// EXTRACT(DAY, User.CreatedAt)
229230
func EXTRACT(field unitType, from Expression) IntegerExpression {
230231
return IntExp(jet.EXTRACT(string(field), from))
231232
}

‎mysql/interval.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,11 @@ const (
3939
type Interval = jet.Interval
4040

4141
// INTERVAL creates new temporal interval.
42-
// In a case of MICROSECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR unit type
43-
// value parameter has to be a number.
42+
//
43+
// In a case of MICROSECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR unit type
44+
// value parameter has to be a number.
4445
// INTERVAL(1, DAY)
45-
// In a case of other unit types, value should be string with appropriate format.
46+
// In a case of other unit types, value should be string with appropriate format.
4647
// INTERVAL("10:08:50", HOUR_SECOND)
4748
func INTERVAL(value interface{}, unitType unitType) Interval {
4849
switch unitType {

‎postgres/expressions.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type NumericExpression = jet.NumericExpression
1818
// IntegerExpression interface
1919
type IntegerExpression = jet.IntegerExpression
2020

21-
//FloatExpression is interface
21+
// FloatExpression is interface
2222
type FloatExpression = jet.FloatExpression
2323

2424
// TimeExpression interface

‎postgres/functions.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,8 @@ const (
296296
)
297297

298298
// EXTRACT function retrieves subfields such as year or hour from date/time values
299-
// EXTRACT(DAY, User.CreatedAt)
299+
//
300+
// EXTRACT(DAY, User.CreatedAt)
300301
func EXTRACT(field unit, from Expression) FloatExpression {
301302
return FloatExp(jet.EXTRACT(unitToString(field), from))
302303
}

‎postgres/interval_expression.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ type intervalExpression struct {
120120
}
121121

122122
// INTERVAL creates new interval expression from the list of quantity-unit pairs.
123-
// INTERVAL(1, DAY, 3, MINUTE)
123+
//
124+
// INTERVAL(1, DAY, 3, MINUTE)
124125
func INTERVAL(quantityAndUnit ...quantityAndUnit) IntervalExpression {
125126
quantityAndUnitLen := len(quantityAndUnit)
126127
if quantityAndUnitLen == 0 || quantityAndUnitLen%2 != 0 {

‎postgres/select_statement.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ type SelectStatement interface {
6565
AsTable(alias string) SelectTable
6666
}
6767

68-
//SELECT creates new SelectStatement with list of projections
68+
// SELECT creates new SelectStatement with list of projections
6969
func SELECT(projection Projection, projections ...Projection) SelectStatement {
7070
return newSelectStatement(nil, append([]Projection{projection}, projections...))
7171
}

‎sqlite/columns.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ type ColumnDateTime = jet.ColumnTimestamp
5151
// DateTimeColumn creates named timestamp column
5252
var DateTimeColumn = jet.TimestampColumn
5353

54-
//ColumnTimestamp is interface of SQL timestamp columns.
54+
// ColumnTimestamp is interface of SQL timestamp columns.
5555
type ColumnTimestamp = jet.ColumnTimestamp
5656

5757
// TimestampColumn creates named timestamp column

‎sqlite/select_statement.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ type SelectStatement interface {
5858
AsTable(alias string) SelectTable
5959
}
6060

61-
//SELECT creates new SelectStatement with list of projections
61+
// SELECT creates new SelectStatement with list of projections
6262
func SELECT(projection Projection, projections ...Projection) SelectStatement {
6363
return newSelectStatement(nil, append([]Projection{projection}, projections...))
6464
}

0 commit comments

Comments
 (0)