You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# sqlite_extensions-uuid
2
2
3
-
Sqlite's [uuid v4 extension](https://sqlite.org/src/file/ext/misc/uuid.c?t=version-3.46.1), packaged as a gem.
3
+
SQLite's [uuid v4 extension](https://sqlite.org/src/file/ext/misc/uuid.c?t=version-3.46.1), packaged as a gem.
4
4
5
5
Useful for using UUIDs as primary keys in a Rails app.
6
6
@@ -18,7 +18,7 @@ If you're _not_ using Rails, you can omit the `require` above.
18
18
19
19
## Usage
20
20
21
-
Sqlite's uuid extension provides the following:
21
+
SQLite's uuid extension provides the following:
22
22
23
23
-`uuid()` - generate a version 4 UUID as a string
24
24
-`uuid_str(X)` - convert a UUID X into a well-formed UUID string
@@ -35,17 +35,17 @@ For more information, see the extension's [source code](https://sqlite.org/src/f
35
35
36
36
## Design
37
37
38
-
This gem compiles Sqlite's uuid extension into a shared library using Ruby's native-gem functionality.
38
+
This gem compiles SQLite's uuid extension into a shared library using Ruby's native-gem functionality.
39
39
40
-
It doesn't actually compile a Ruby native extension, it just uses the ruby extension process to compile the Sqlite library.
40
+
It doesn't actually compile a Ruby native extension, it just uses the ruby extension process to compile the SQLite library.
41
41
42
42
It then exposes a method (`SqliteExtensions::UUID.extension_path`) which returns the location of that shared library, which can be passed to [sqlite3](https://github.com/sparklemotion/sqlite3-ruby)'s `load_extension` method.
43
43
44
-
Additionally, it exposes a railtie (via `require: "sqlite_extensions/uuid/rails"`) that patches Rails' [configure_connection](https://github.com/rails/rails/blob/v8.0.0.rc1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L815) method for the sqlite adapter, so that all sqlite database connections load the extension.
44
+
Additionally, it exposes a railtie (via `require: "sqlite_extensions/uuid/rails"`) that patches Rails' [configure_connection](https://github.com/rails/rails/blob/v8.0.0.rc1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L815) method for the SQLite adapter, so that all SQLite database connections load the extension.
45
45
46
46
## Development
47
47
48
-
```
48
+
```shell
49
49
# one-time setup
50
50
bundle
51
51
@@ -64,7 +64,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jethro
64
64
65
65
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
66
66
67
-
The following files are copied verbatim from Sqlite, and are used under their own license, which is visible at the beginning of each file:
67
+
The following files are copied verbatim from SQLite, and are used under their own license, which is visible at the beginning of each file:
0 commit comments