Make the version number comparable #292
Comments
|
Or even simpler, use a compile time macro to define both the version string and a numeric representation. |
fluca1978
added a commit
to fluca1978/pgagroal
that referenced
this issue
Jul 28, 2022
This commit introduces two compile time macros:
- PGAGROAL_VERSION is a string and contains the application version
that will be shown in various application messages.
- PGAGROAL_VERSION_NUM is a numeric value that can be used to compare
the running version with another number, so for example to limit
features or messages.
`PGAGROAL_VERSION` replaces the `VERSION` macro that was defined in
the main header file.
Moreover, the message printed at level INFO when booting the pooler
has been enhanced to show also the version that is starting, like for
instance:
pgagroal: v1.5.0 started on *:5432
See agroal#253, agroal#289, agroal#290
Close agroal#292
|
👍 |
fluca1978
added a commit
to fluca1978/pgagroal
that referenced
this issue
Jul 28, 2022
Three new constants are introduced here:
- PGAGROAL_MAJOR_VERSION (number)
- PGAGROAL_MINOR_VERSION (number)
- PGAGROAL_PATCH_VERSION (number)
- PGAGROAL_VERSION (string)
that represent, as integer literals and string composition,
the parts of the version number.
The values are copied from the variables in the `CmakeLists.txt` file
that creates the building flow, so changing the values in a single
place changes and propagates the changes all over the source code.
A few utility functions have been introduced to compose the three
constant into a unique number that can be used to compare the version
currently running, so that features and/or message can be targeted as
conditionals.
Introduced functions are:
- pgagroal_version_as_number() returns an unique sortable version
number. For example, version 1.5.0 is returned as 15000, version 1.6.2
as 16002, and so on;
- pgagroal_version_number() returns the currently running version
number, that is invokes pgagroal_version_as_number() with the
predefined constants.
The `pgagroal_version_as_number()` accepts individual values, while
`pgagroal_version_number()` provides the currently running version
number. The idea is that, thanks to both the functions, it is possible
to check for a feature that depends on a version in a way like the
following one:
if (pgagroal_version_numer() >=
pgagroal_version_as_number(2,1,0))
// version is greater than 2.1.0 !
The utility function `pgagroal_version_ge()` does exactly the above:
it accepts the three parts of a version number and checks if the
currently running version is greater or equal (hence, 'ge') of the
specified triplet, so that the above piece of code becomes:
if (pgagroal_version_ge(2,1,0))
// version greater or equal 2.1.0
Close agroal#292
See agroal#253, agroal#289, agroal#290, agroal#293
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In
pgagroal.hthe version of the pooler is defined as a constant string:this makes hard to compare version numbers within the program. I propose to split the version number into three numeric parts, providing an utility function to get the string-yfied version of the version number to display.
This is useful also to decide which part of code are deprecated or not depending on the version, as per discussion and needs in #289, #290, and #253.
The text was updated successfully, but these errors were encountered: