(:toc-back Back to Table of Contents:)

!!! Table migration

!!!! Subscriber

* On Debian and Fedora/Redhat, the opensips-berkeley-module, opensips-mysql-module, opensips-postgres-module and opensips-sqlite-module packages no longer come with the associated database schemas for each backend - instead, four new packages are being built, namely opensips-berkeley-dbschema, opensips-mysql-dbschema, opensips-postgres-dbschema and opensips-sqlite-dbschema, which contain the corresponding database schema for each backend. Since there is no cross dependency between the module and the dbschema, if one needs the schema as well, it needs to be installed the dbschema package separately. This change is being done on purpose, to be able to install the dbschema files on separate machines, and use them separately to install (for example using opensips-cli).

* paramameter [[https://opensips.org/docs/modules/3.5.x/prometheus.html#param_script_route_avp_result|script_route_avp_result]] has been dropped, and its behavior has been replaced with the newly added return values. Check the [[https://opensips.org/docs/modules/3.5.x/prometheus.html#param_script_route|script_route]] documentation for more information.

!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.4.x to 3.5.0

This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.4.0''' version to '''3.5.0'''.

You can find the all the new additions in the '''3.5.0''' release compiled [[ About.Version-3-5-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.

You can migrate your 3.4.x MySQL DB to the 3.5.x format using the '''opensips-cli''' tool :

# opensips-cli -x database migrate 3.4_to_3.5 opensips_3_4 opensips_3_5

* opensips_3_4 is the existing DB name corresponding to version 3.4.x format
* opensips_3_5 is the DB name to be created for 3.5.x format

* The [[https://www.opensips.org/Documentation/Script-CoreParameters-3-5#toc57|@@mpath@@]] parameter can take several values. This means that if your script contains several declarations, and you rely on the fact that only the last one is being used, you need to completely delete (or comment) the previous ones, otherwise they will be taken into account in the modules search algorithm, and moreover, they will be prioritized.

!!!! Core Variables

* consider using the new [[https://www.opensips.org/Documentation/Script-CoreFunctions-3-5#set_via_handling|set_via_handling()]] instead of force_rport(), add_local_report() or force_tcp_alias() (which are to be deprecated in the future)

!!!! Core MI commands

!!!! AVPOPS module
This module does not exist anymore. All its functions were re-distributed and replaced as follows:
* '''avp_db_load/store/delete()''' functions were moved and renamed as '''sql_avp_load/store_delete()''' in the [[https://opensips.org/html/docs/modules/3.5.x/sqlops.html|sqlops module]]
* '''avp_db_query()''' function was moved and renamed as '''sql_query()''' in the [[https://opensips.org/html/docs/modules/3.5.x/sqlops.html|sqlops module]]
* '''avp_remove()''' function was removed, as it can be replaced with scripting @@$avp(x):=NULL@@
* '''avp_pushto()''' function was removed, as it can be replaced with scripting assignment operation
* '''avp_check()''' function was removed, as it can be replaced with scripting testing operators
* '''avp_copy()''' function was removed, as it can be replaced with scripting assignment operation
* '''avp_subst()''' function was removed, as it can be replaced with scripting [[https://www.opensips.org/Documentation/Script-Tran-3-5#re.subst|{re.subst}]] transformation
* '''avp_op()''' function was removed, as it can be replaced with scripting operations
* '''is_avp_set()''' function was removed, as it can be replaced with scripting @@if ($avp(x)==NULL) {}@@
* '''avp_shuffle()''' function was moved under the [[https://opensips.org/html/docs/modules/3.5.x/cfgutils.html#func_shuffle_avps|shuffle_avps()]] name into the '''cfgutils''' module
* '''avp_print()''' function was moved to the OpenSIPS core under the same name

!!!! SQL_CACHER module
* '''BE CAREFUL''', the DOUBLE types are now returned as strings, rather than corrupted numerical values.

* consider using the new [[https://www.opensips.org/Documentation/Script-CoreFunctions-3-5#set_via_handling|set_via_handling]] instead of force_rport(), add_local_report() or force_tcp_alias() (which are to be deprecated in the future)

* renamed into DBops module

* BE CAREFUL, the DOUBLE types are now returned as strings, rather than corrupted numerical values.

* example

* example

You can find the all the new additions in the '''3.5.0''' release compiled [[ About.Version-3-4-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.

!!!! CACHEDB_LOCAL module
* added cache_fetch_chunk("keyprefix*", collection) MI function

* the DOUBLE types are now returned as strings, rather than corrupted numerical values.

!!!! B2B_LOGIC module
* example

!!!! AUTH modules
*

* example

!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 3.3.x to 3.4.0

This section is meant to provide useful help in migrating your OpenSIPS installations from the '''3.3.0''' version to '''3.4.0'''.

You can find the all the new additions in the '''3.4.0''' release compiled [[ About.Version-3-4-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.

You can migrate your 3.3.x MySQL DB to the 3.4.x format using the '''opensips-cli''' tool :

# opensips-cli -x database migrate 3.3_to_3.4 opensips_3_3 opensips_3_4

* opensips_3_3 is the existing DB name corresponding to version 3.3.x format
* opensips_3_4 is the DB name to be created for 3.4.x format

* [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#log_facility|log_facility]] has been deprecated and replaced with [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#syslog_facility|syslog_facility]].
* [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#log_name|log_name]] has been deprecated and replaced with [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#syslog_name|syslog_name]].
* [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#log_stderror|log_stderror]] has been deprecated and is now equivalent with setting the new [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#stderror_enabled|stderror_enabled]] and [[https://www.opensips.org/Documentation/Script-CoreParameters-3-4#syslog_enabled|syslog_enabled]] parameters as following:
** ''log_stderror=yes'' - ''stderror_enabled=yes'' and ''syslog_enabled=no'' (default)
** ''log_stderror=no'' - ''stderror_enabled=no'' and ''syslog_enabled=yes''.

!!!! Core Variables

* the output of the [[https://www.opensips.org/Documentation/Interface-CoreMI-3-4#list_blacklists|list_blacklists]] rules have changed to improve readability:
** ''owner'' - now a string
** ''expire'' - indicates the number of seconds until the rule expires
** ''proto'' - printed as string protocol, or "any"

!!!! Statistics migration

* The flags of the [[https://opensips.org/docs/modules/3.4.x/b2b_logic.html#func_b2b_bridge|b2b_bridge()]] function have been renamed as following:
** '''n''' to '''notify'''
** '''f''' to '''rollback-failed'''
** '''t[nn]''' to '''max_duration=[int]'''.
* The flags of the [[https://opensips.org/docs/modules/3.4.x/b2b_logic.html#func_b2b_init_request|b2b_init_request()]] function have been renamed as following:
** '''a''' to '''transparent-auth'''
** '''p''' to '''preserve-to'''
** '''t[nn]''' to '''setup-timeout=[nn]'''
* The '''init_sdp_body''' and '''init_sdp_ctype''' parameters of the [[https://opensips.org/docs/modules/3.4.x/b2b_logic.html#func_b2b_init_request|b2b_init_request()]] function have been dropped.
* The '''use_init_sdp''' module parameter has been dropped.

!!!! CFGUTILS module
* the 'ts_usec_delta()' 5th parameter has changed

!!!! CGRateS module

!!!! DIALOG module
* The '''val''' parameter of [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_store_dlg_value|store_dlg_value()]] is now a variable.
* the first parameter, '''idx''' of the [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_set_dlg_flag|set_dlg_flag()]], [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_test_and_set_dlg_flag|test_and_set_dlg_flag()]], [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_reset_dlg_flag|reset_dlg_flag()]], [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_is_dlg_flag_set|is_dlg_flag_set()]] functions is now a static string.
* The [[https://opensips.org/docs/modules/3.4.x/dialog.html#pv_DLG_flags|$DLG_flags]] variable now returns a list of flag names separted by space instead of a single integer value.

!!!! MID_REGISTRAR module
* Check the module docs for the '''flags''' parameters of the [[https://opensips.org/docs/modules/3.4.x/mid_registrar.html#func_mid_registrar_save|mid_registrar_save()]] and [[https://opensips.org/docs/modules/3.4.x/mid_registrar.html#func_mid_registrar_lookup|mid_registrar_lookup()]] functions for the mapping between the old and new flag names.


!!!! NATHELPER module
* Check the module docs for the '''flags''' parameters of the [[https://opensips.org/docs/modules/3.4.x/nathelper.html#func_fix_nated_sdp|fix_nated_sdp()]] and [[https://opensips.org/docs/modules/3.4.x/nathelper.html#func_nat_uac_test|nat_uac_test()]] functions for the mapping between the old and new flag names.

!!!! REGISTRAR module
* Check the module docs for the '''flags''' parameters of the [[https://opensips.org/docs/modules/3.4.x/registrar.html#func_save|save()]] and [[https://opensips.org/docs/modules/3.4.x/registrar.html#func_lookup|lookup()]] functions for the mapping between the old and new flag names.

!!!! TM module
* Check the module docs for the '''flags''' parameter of the [[https://opensips.org/docs/modules/3.4.x/tm.html#func_t_relay|t_relay()]] function for the mapping between the old and new flag names.

* NEW package available in the repos: '''opensips-auth-modules''', containing both the '''[[ https://opensips.org/docs/modules/3.4.x/auth.html | auth ]]''' and '''[[ https://opensips.org/docs/modules/3.4.x/uac_auth.html | uac_auth ]]''' modules, mainly due to their extra dependency on a TLS library to be present on the system (e.g. OpenSSL or WolfSSL)

* example

* NEW package available in the repos: '''opensips-auth-modules''', containing both the '''auth''' and '''uac_auth''' modules, mainly due to their extra dependency on a TLS library to be present on the system (e.g. OpenSSL or WolfSSL)

* NEW package available in the repos: '''opensips-auth-modules''', containing both the '''auth''' and '''uac_auth''' modules, mainly due to their extra dependency on a TLS library (e.g. OpenSSL or WolfSSL)

* the '''auth''' and '''uac_auth''' module are now part of a new package, '''opensips-auth-modules''', mainly due to their extra dependency on a TLS library (e.g. OpenSSL or WolfSSL)

* Check the module docs for the '''flags''' parameter of the [[https://opensips.org/docs/modules/3.4.x/tm.html#func_t_relay|t_relay()]] function for the mapping between the old and new flag names.

* The [[https://opensips.org/docs/modules/3.4.x/dialog.html#pv_DLG_flags|$DLG_flags]] variable now returns a list of flag names separted by space instead of a single integer value.

* The [[https://opensips.org/docs/modules/3.4.x/dialog.html#pv_DLG_flags|$DLG_flags]] variable now returns a list of flag names separted by space instead of a single integer value).

* The '''val''' parameter of [[https://opensips.org/docs/modules/3.4.x/dialog.html#func_store_dlg_value|store_dlg_value()]] is now a variable.

* example

* The flags of the [[https://opensips.org/docs/modules/3.4.x/b2b_logic.html#func_b2b_bridge_retry|b2b_bridge_retry()]] function have been renamed as following:

* The flags of the [[https://opensips.org/docs/modules/3.4.x/b2b_logic.html#func_b2b_init_request|b2b_bridge_retry()]] function have been renamed as following:

* the output of the [[https://www.opensips.org/Documentation/Interface-CoreMI-3-4#list_blacklists]] rules have changed to improve readability:

* example