@@ -436,22 +436,19 @@ Connection Objects
436
436
437
437
.. method :: create_collation(name, callable)
438
438
439
- Creates a collation with the specified *name * and *callable *. The callable will
440
- be passed two string arguments. It should return -1 if the first is ordered
441
- lower than the second, 0 if they are ordered equal and 1 if the first is ordered
442
- higher than the second. Note that this controls sorting (ORDER BY in SQL) so
443
- your comparisons don't affect other SQL operations.
439
+ Create a collation named *name * using the collating function *callable *.
440
+ *callable * is passed two :class: `string <str> ` arguments,
441
+ and it should return an :class: `integer <int> `:
444
442
445
- Note that the callable will get its parameters as Python bytestrings, which will
446
- normally be encoded in UTF-8.
443
+ * ``1 `` if the first is ordered higher than the second
444
+ * ``-1 `` if the first is ordered lower than the second
445
+ * ``0 `` if they are ordered equal
447
446
448
- The following example shows a custom collation that sorts "the wrong way" :
447
+ The following example shows a reverse sorting collation :
449
448
450
449
.. literalinclude :: ../includes/sqlite3/collation_reverse.py
451
450
452
- To remove a collation, call ``create_collation `` with ``None `` as callable::
453
-
454
- con.create_collation("reverse", None)
451
+ Remove a collation function by setting *callable * to :const: `None `.
455
452
456
453
457
454
.. method :: interrupt()
0 commit comments