Skip to content

Commit 7a25bac

Browse files
committed
Update docs to reflect rename of Expression to SQLExpression
1 parent ea08bd5 commit 7a25bac

File tree

10 files changed

+95
-323
lines changed

10 files changed

+95
-323
lines changed

Documentation/Index.md

Lines changed: 64 additions & 206 deletions
Large diffs are not rendered by default.

Documentation/Linux.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

Documentation/Planning.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

Documentation/Release.md

Lines changed: 0 additions & 13 deletions
This file was deleted.
-305 KB
Binary file not shown.
-399 KB
Binary file not shown.

Documentation/Upgrading.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and works out-of-the-box on macOS, iOS, Linux, Android, and Windows.
1010
- A pure-Swift interface
1111
- A type-safe, optional-aware SQL expression builder
1212
- A flexible, chainable, lazy-executing query layer
13+
- Uses a built-in, modern sqlite version
1314
- Automatically-typed data access
1415
- A lightweight, uncomplicated query and parameter binding interface
1516
- Developer-friendly error handling and debugging
@@ -18,7 +19,7 @@ and works out-of-the-box on macOS, iOS, Linux, Android, and Windows.
1819
- Extensively tested
1920
- [SQLCipher][] support
2021
- [Schema query/migration][]
21-
- Works on Android, Windows, and [Linux](Documentation/Linux.md) (with some limitations)
22+
- Works on iOS, macOS, Android, Windows, and Linux
2223

2324
[SQLCipher]: https://www.zetetic.net/sqlcipher/
2425
[Full-text search]: Documentation/Index.md#full-text-search
@@ -36,9 +37,9 @@ do {
3637
let db = try Connection("path/to/db.sqlite3")
3738

3839
let users = Table("users")
39-
let id = Expression<Int64>("id")
40-
let name = Expression<String?>("name")
41-
let email = Expression<String>("email")
40+
let id = SQLExpression<Int64>("id")
41+
let name = SQLExpression<String?>("name")
42+
let email = SQLExpression<String>("email")
4243

4344
try db.run(users.create { t in
4445
t.column(id, primaryKey: true)
@@ -77,7 +78,7 @@ do {
7778
}
7879
```
7980

80-
SQLite.swift also works as a lightweight, Swift-friendly wrapper over the C
81+
SQLiteDB also works as a lightweight, Swift-friendly wrapper over the C
8182
API.
8283

8384
```swift
@@ -143,7 +144,6 @@ Swift code.
143144
- Found a **bug** or have a **feature request**? [Open an issue][].
144145
- Want to **contribute**? [Submit a pull request][].
145146

146-
[See the planning document]: /Documentation/Planning.md
147147
[Read the contributing guidelines]: ./CONTRIBUTING.md#contributing
148148
[Ask on Stack Overflow]: https://stackoverflow.com/questions/tagged/sqlite.swift
149149
[Open an issue]: https://github.com/skiptools/swift-sqlite/issues/new
@@ -167,8 +167,6 @@ Looking for something else? Try another Swift wrapper (or [FMDB][]):
167167

168168
- [SQLite.swift](https://github.com/stephencelis/SQLite.swift)
169169
- [GRDB](https://github.com/groue/GRDB.swift)
170-
- [SQLiteDB](https://github.com/FahimF/SQLiteDB)
171-
- [Squeal](https://github.com/nerdyc/Squeal)
172170

173171
[Swift]: https://swift.org/
174172
[SQLite3]: https://www.sqlite.org

Sources/SQLiteDB/Typed/Query+with.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ extension QueryType {
2828
/// Sets a `WITH` clause on the query.
2929
///
3030
/// let users = Table("users")
31-
/// let id = Expression<String>("email")
32-
/// let name = Expression<String?>("name")
31+
/// let id = SQLExpression<String>("email")
32+
/// let name = SQLExpression<String?>("name")
3333
///
3434
/// let userNames = Table("user_names")
3535
/// userCategories.with(userNames, as: users.select(name))

Sources/SQLiteDB/Typed/Query.swift

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ extension SchemaType {
4242
/// Builds a copy of the query with the `SELECT` clause applied.
4343
///
4444
/// let users = Table("users")
45-
/// let id = Expression<Int64>("id")
46-
/// let email = Expression<String>("email")
45+
/// let id = SQLExpression<Int64>("id")
46+
/// let email = SQLExpression<String>("email")
4747
///
4848
/// users.select(id, email)
4949
/// // SELECT "id", "email" FROM "users"
@@ -58,7 +58,7 @@ extension SchemaType {
5858
/// Builds a copy of the query with the `SELECT DISTINCT` clause applied.
5959
///
6060
/// let users = Table("users")
61-
/// let email = Expression<String>("email")
61+
/// let email = SQLExpression<String>("email")
6262
///
6363
/// users.select(distinct: email)
6464
/// // SELECT DISTINCT "email" FROM "users"
@@ -73,8 +73,8 @@ extension SchemaType {
7373
/// Builds a copy of the query with the `SELECT` clause applied.
7474
///
7575
/// let users = Table("users")
76-
/// let id = Expression<Int64>("id")
77-
/// let email = Expression<String>("email")
76+
/// let id = SQLExpression<Int64>("id")
77+
/// let email = SQLExpression<String>("email")
7878
///
7979
/// users.select([id, email])
8080
/// // SELECT "id", "email" FROM "users"
@@ -89,7 +89,7 @@ extension SchemaType {
8989
/// Builds a copy of the query with the `SELECT DISTINCT` clause applied.
9090
///
9191
/// let users = Table("users")
92-
/// let email = Expression<String>("email")
92+
/// let email = SQLExpression<String>("email")
9393
///
9494
/// users.select(distinct: [email])
9595
/// // SELECT DISTINCT "email" FROM "users"
@@ -132,7 +132,7 @@ extension SchemaType {
132132
/// Builds a scalar copy of the query with the `SELECT` clause applied.
133133
///
134134
/// let users = Table("users")
135-
/// let id = Expression<Int64>("id")
135+
/// let id = SQLExpression<Int64>("id")
136136
///
137137
/// users.select(id)
138138
/// // SELECT "id" FROM "users"
@@ -151,7 +151,7 @@ extension SchemaType {
151151
/// applied.
152152
///
153153
/// let users = Table("users")
154-
/// let email = Expression<String>("email")
154+
/// let email = SQLExpression<String>("email")
155155
///
156156
/// users.select(distinct: email)
157157
/// // SELECT DISTINCT "email" FROM "users"
@@ -186,7 +186,7 @@ extension QueryType {
186186
/// Adds a `UNION` clause to the query.
187187
///
188188
/// let users = Table("users")
189-
/// let email = Expression<String>("email")
189+
/// let email = SQLExpression<String>("email")
190190
///
191191
/// users.filter(email == "alice@example.com").union(users.filter(email == "sally@example.com"))
192192
/// // SELECT * FROM "users" WHERE email = 'alice@example.com' UNION SELECT * FROM "users" WHERE email = 'sally@example.com'
@@ -209,9 +209,9 @@ extension QueryType {
209209
/// Adds a `JOIN` clause to the query.
210210
///
211211
/// let users = Table("users")
212-
/// let id = Expression<Int64>("id")
212+
/// let id = SQLExpression<Int64>("id")
213213
/// let posts = Table("posts")
214-
/// let userId = Expression<Int64>("user_id")
214+
/// let userId = SQLExpression<Int64>("user_id")
215215
///
216216
/// users.join(posts, on: posts[userId] == users[id])
217217
/// // SELECT * FROM "users" INNER JOIN "posts" ON ("posts"."user_id" = "users"."id")
@@ -230,9 +230,9 @@ extension QueryType {
230230
/// Adds a `JOIN` clause to the query.
231231
///
232232
/// let users = Table("users")
233-
/// let id = Expression<Int64>("id")
233+
/// let id = SQLExpression<Int64>("id")
234234
/// let posts = Table("posts")
235-
/// let userId = Expression<Int64?>("user_id")
235+
/// let userId = SQLExpression<Int64?>("user_id")
236236
///
237237
/// users.join(posts, on: posts[userId] == users[id])
238238
/// // SELECT * FROM "users" INNER JOIN "posts" ON ("posts"."user_id" = "users"."id")
@@ -251,9 +251,9 @@ extension QueryType {
251251
/// Adds a `JOIN` clause to the query.
252252
///
253253
/// let users = Table("users")
254-
/// let id = Expression<Int64>("id")
254+
/// let id = SQLExpression<Int64>("id")
255255
/// let posts = Table("posts")
256-
/// let userId = Expression<Int64>("user_id")
256+
/// let userId = SQLExpression<Int64>("user_id")
257257
///
258258
/// users.join(.LeftOuter, posts, on: posts[userId] == users[id])
259259
/// // SELECT * FROM "users" LEFT OUTER JOIN "posts" ON ("posts"."user_id" = "users"."id")
@@ -274,9 +274,9 @@ extension QueryType {
274274
/// Adds a `JOIN` clause to the query.
275275
///
276276
/// let users = Table("users")
277-
/// let id = Expression<Int64>("id")
277+
/// let id = SQLExpression<Int64>("id")
278278
/// let posts = Table("posts")
279-
/// let userId = Expression<Int64?>("user_id")
279+
/// let userId = SQLExpression<Int64?>("user_id")
280280
///
281281
/// users.join(.LeftOuter, posts, on: posts[userId] == users[id])
282282
/// // SELECT * FROM "users" LEFT OUTER JOIN "posts" ON ("posts"."user_id" = "users"."id")
@@ -302,7 +302,7 @@ extension QueryType {
302302
/// Adds a condition to the query’s `WHERE` clause.
303303
///
304304
/// let users = Table("users")
305-
/// let id = Expression<Int64>("id")
305+
/// let id = SQLExpression<Int64>("id")
306306
///
307307
/// users.filter(id == 1)
308308
/// // SELECT * FROM "users" WHERE ("id" = 1)
@@ -317,7 +317,7 @@ extension QueryType {
317317
/// Adds a condition to the query’s `WHERE` clause.
318318
///
319319
/// let users = Table("users")
320-
/// let age = Expression<Int?>("age")
320+
/// let age = SQLExpression<Int?>("age")
321321
///
322322
/// users.filter(age >= 35)
323323
/// // SELECT * FROM "users" WHERE ("age" >= 35)
@@ -426,8 +426,8 @@ extension QueryType {
426426
/// Sets an `ORDER BY` clause on the query.
427427
///
428428
/// let users = Table("users")
429-
/// let email = Expression<String>("email")
430-
/// let name = Expression<String?>("name")
429+
/// let email = SQLExpression<String>("email")
430+
/// let name = SQLExpression<String?>("name")
431431
///
432432
/// users.order(email.desc, name.asc)
433433
/// // SELECT * FROM "users" ORDER BY "email" DESC, "name" ASC
@@ -442,8 +442,8 @@ extension QueryType {
442442
/// Sets an `ORDER BY` clause on the query.
443443
///
444444
/// let users = Table("users")
445-
/// let email = Expression<String>("email")
446-
/// let name = Expression<String?>("name")
445+
/// let email = SQLExpression<String>("email")
446+
/// let name = SQLExpression<String?>("name")
447447
///
448448
/// users.order([email.desc, name.asc])
449449
/// // SELECT * FROM "users" ORDER BY "email" DESC, "name" ASC

0 commit comments

Comments
 (0)