django-sequences 3.0

get_next_value

>>> from sequences import get_next_value

此函数生成一个无间隔的整数值序列

>>> get_next_value()
1
>>> get_next_value()
2
>>> get_next_value()
3

它支持多个独立的序列

>>> get_next_value("cases")
1
>>> get_next_value("cases")
2
>>> get_next_value("invoices")
1
>>> get_next_value("invoices")
2

第一个值默认为1。它可以自定义

>>> get_next_value("customers", initial_value=1000)  # pro growth hacking

initial_value 参数仅在第一次调用给定序列的 get_next_value 时才有意义——假设相应的数据库事务得到提交；如上所述，如果事务回滚，则生成的值不会被消耗。也可以在数据迁移中初始化序列，而在实际代码中不使用 initial_value。

序列可以循环

>>> get_next_value("seconds", initial_value=0, reset_value=60)

当序列达到 reset_value 时，它将从 initial_value 重新开始。换句话说，它生成 reset_value - 2、reset_value - 1、initial_value、initial_value + 1 等。在这种情况下，每次调用 get_next_value 时都必须提供 initial_value（如果不是默认值）和 reset_value。

调用给定序列的 get_next_value 的数据库事务是串行化的。 因此，当您在数据库事务中调用 get_next_value 时，其他尝试从同一序列获取值的调用者将阻塞，直到事务完成（无论是提交还是回滚）。您应该尽量缩短此类事务，以最小化对性能的影响。

这就是为什么数据库默认采用可能产生空隙的更快行为的原因。

传递 nowait=True 将使 get_next_value 在此场景中引发异常而不是阻塞。这很少有用。此外，它不适用于第一次调用。（这是一个错误，但它无害且难以修复。）

对不同序列的 get_next_value 调用之间不交互。

最后，通过传递 using="..." 可以选择存储当前序列值的数据库。当此参数未提供时，它默认为 sequences 应用程序模型写入的默认数据库。有关详细信息，请参阅多个数据库。

总结一下，get_next_value 的完整签名是

get_next_value(
    sequence_name="default",
    initial_value=1,
    reset_value=None,
    *,
    nowait=False,
    using=None,
)

get_next_values

>>> from sequences import get_next_values

此函数批量生成值

>>> get_next_values(10)
range(1, 11)
>>> get_next_values(10)
range(11, 21)

提醒一下，您必须在同一个事务中保存所有这些值，才能从django-sequences的保证中受益。

get_next_values 支持与 get_next_value 相同的参数，除了 reset_value。

get_next_values 的完整签名是

get_next_values(
    batch_size,
    sequence_name="default",
    initial_value=1,
    *,
    nowait=False,
    using=None,
)

get_last_value

>>> from sequences import get_last_value

此函数返回序列生成的最后一个值

>>> get_last_value()
None
>>> get_next_value()
1
>>> get_last_value()
1
>>> get_next_value()
2
>>> get_last_value()
2

如果序列尚未生成值，则 get_last_value 返回 None。

它支持独立的序列，如 get_next_value。

>>> get_next_value("cases")
1
>>> get_last_value("cases")
1
>>> get_next_value("invoices")
1
>>> get_last_value("invoices")
1

它接受 using="..." 以选择存储当前序列值的数据库，默认为 sequences 应用程序的读取模型的默认数据库。

get_last_value 的完整签名是

get_last_value(
    sequence_name="default",
    *,
    using=None,
)

get_last_value 是一种方便快捷的方式来了解序列生成了多少值，但它不提供任何保证。并发调用 get_next_value 可能会产生 get_last_value 的意外结果。

删除

>>> from sequences import delete

此函数删除一个序列。如果序列存在并被删除，则返回 True，否则返回 False。

>>> company_id = "b1f6cdef-367f-49e4-9cf5-bb0d34707af8"
>>> get_next_value(f"invoices—{company_id}")
1
>>> delete(f"invoices—{company_id}")
True
>>> delete(f"invoices—{company_id}")
False

它接受 using="..." 以选择数据库，类似于 get_next_value。

delete 的完整签名是

delete(
    sequence_name="default",
    *,
    using=None,
)

delete 在创建许多序列并希望丢弃一些时很有用。

序列

>>> from sequences import Sequence

(不要与 sequences.models.Sequence 混淆，这是一个私有 API)

此类存储序列的参数并提供 get_next_value、get_next_values、get_last_value 和 delete 方法

>>> claim_ids = Sequence("claims")
>>> claim_ids.get_next_value()
1
>>> claim_ids.get_next_value()
2
>>> claim_ids.get_last_value()
2
>>> claim_ids.delete()
True

这降低了在多个地方使用相同序列时的错误风险。

Sequence 的实例也是无限迭代器

>>> next(claim_ids)
3
>>> next(claim_ids)
4

完整的 API 是

Sequence(
    sequence_name="default",
    initial_value=1,
    reset_value=None,
    *,
    using=None,
)

Sequence.get_next_value(
    self,
    *,
    nowait=False,
)

Sequence.get_next_values(
    self,
    batch_size,
    *,
    nowait=False,
)

Sequence.get_last_value(
    self,
)

Sequence.delete(
    self,
)

所有参数的含义与 get_next_value、get_last_values、get_last_value 和 delete 函数中的含义相同。

3.0

• 添加生成批处理值的 get_next_values 函数。

2.9

• 添加 delete 函数。

2.8

• 没有重大变化。

2.7

• 序列值可以高达 2 ** 63 - 1，而不是之前的前 2 ** 31 - 1。确切的限制取决于数据库后端。

  迁移 0002_alter_sequence_last.py 将存储序列值的字段从 PositiveIntegerField 更改为 PositiveBigIntegerField。运行它需要表的独占锁，这会阻止其他操作，包括读取。

  如果您有大量不同的序列，例如，如果您为每个用户创建一个序列并且您有数百万用户，请在运行迁移之前审查它对应用程序的影响，或者使用 migrate --fake 跳过它。

2.6

• 改进文档。

2.5

• 修复日语和土耳其语翻译。

• 恢复与 Python 3.5 的兼容性。

• 支持使用自定义 AppConfig 重命名 sequences 应用。

2.4

• 添加 get_last_value 函数。

• 添加 Sequence 类。

2.3

• 优化 MySQL 性能。

• 在 MySQL、SQLite 和 Oracle 上进行测试。

2.2

• 优化 PostgreSQL ≥ 9.5 的性能。

2.1

• 提供带有 reset_value 的循环序列。

2.0

• 添加对多个数据库的支持。

• 添加翻译。

• nowait 成为关键字参数。

• 取消对 Python 2 的支持。

1.0

• 初始稳定版本。