diff --git a/docs/2.7.9/docs/daml/intro/9_Dependencies.rst b/docs/2.7.9/docs/daml/intro/9_Dependencies.rst index d2acc98df..b17472cf9 100644 --- a/docs/2.7.9/docs/daml/intro/9_Dependencies.rst +++ b/docs/2.7.9/docs/daml/intro/9_Dependencies.rst @@ -9,7 +9,7 @@ The application from :doc:`7_Composing` is a complete and secure model for atomi 1. Upgrades, which change existing logic. For example, one might want the ``Asset`` template to have multiple signatories. 2. Extensions, which merely add new functionality through additional templates. -Upgrades are covered in their own section outside this introduction to Daml: :doc:`/upgrade/index` so in this section we will extend the :doc:`7_Composing` model with a simple second workflow: a multi-leg trade. In doing so, you'll learn about: +Upgrades are covered in their own section outside this introduction to Daml: :doc:`/upgrade/upgrade` so in this section we will extend the :doc:`7_Composing` model with a simple second workflow: a multi-leg trade. In doing so, you'll learn about: - The software architecture of the Daml Stack - Dependencies and Data Dependencies diff --git a/docs/3.1/_toc.yml b/docs/3.1/_toc.yml index ed8685774..6a416ae91 100644 --- a/docs/3.1/_toc.yml +++ b/docs/3.1/_toc.yml @@ -234,15 +234,12 @@ subtrees: - file: daml/resource-management/contention-reducing.rst - file: daml/resource-management/contention-techniques.rst - file: daml/resource-management/active-contract-set - - file: upgrade/index - title: "Upgrading and Extending Daml Applications" - entries: - - file: upgrade/extend - title: "Extending Daml Applications" - - file: upgrade/upgrade - title: "Upgrading Daml Applications" - - file: upgrade/automation - title: "Automating the Upgrade Process" + - file: upgrade/extend + title: "Extend Daml Applications" + - file: upgrade/upgrade + title: "Upgrade Daml Applications" + - file: upgrade/automation + title: "Automate Daml Application Upgrades" - file: create-daml-apps/developer-tools/index title: "Developer Tools" subtrees: diff --git a/docs/3.1/docs/daml/intro/9_Dependencies.rst b/docs/3.1/docs/daml/intro/9_Dependencies.rst index d2acc98df..b17472cf9 100644 --- a/docs/3.1/docs/daml/intro/9_Dependencies.rst +++ b/docs/3.1/docs/daml/intro/9_Dependencies.rst @@ -9,7 +9,7 @@ The application from :doc:`7_Composing` is a complete and secure model for atomi 1. Upgrades, which change existing logic. For example, one might want the ``Asset`` template to have multiple signatories. 2. Extensions, which merely add new functionality through additional templates. -Upgrades are covered in their own section outside this introduction to Daml: :doc:`/upgrade/index` so in this section we will extend the :doc:`7_Composing` model with a simple second workflow: a multi-leg trade. In doing so, you'll learn about: +Upgrades are covered in their own section outside this introduction to Daml: :doc:`/upgrade/upgrade` so in this section we will extend the :doc:`7_Composing` model with a simple second workflow: a multi-leg trade. In doing so, you'll learn about: - The software architecture of the Daml Stack - Dependencies and Data Dependencies diff --git a/docs/3.1/docs/upgrade/extend.rst b/docs/3.1/docs/upgrade/extend.rst index 5735d4a71..5bb42cd6d 100644 --- a/docs/3.1/docs/upgrade/extend.rst +++ b/docs/3.1/docs/upgrade/extend.rst @@ -7,6 +7,8 @@ Extending Daml Applications .. .. toctree:: :hidden: +An extension adds new templates and data structures to your Daml model, while leaving all previously written definitions unchanged. + Consider the following simple Daml model for carbon certificates: .. literalinclude:: example/carbon-1.0.0/daml/CarbonV1.daml diff --git a/docs/3.1/docs/upgrade/index.rst b/docs/3.1/docs/upgrade/index.rst deleted file mode 100644 index 238942bea..000000000 --- a/docs/3.1/docs/upgrade/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. Copyright (c) 2023 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. -.. SPDX-License-Identifier: Apache-2.0 - -Upgrading and Extending Daml Applications -######################################### - -.. .. toctree:: - :hidden: - - extend - upgrade - automation - -Database schemas tend to evolve over time. A new feature in your application -might need an additional choice in one of your templates. Or a change in your -data model will make you application perform better. We distinguish two kinds of -changes to a Daml model: - - - A Daml model extension - - A Daml model upgrade - -An *extension* adds new templates and data structures to your model, while -leaving all previously written definitions unchanged. - -An *upgrade* changes previously defined data structures and templates. - -Whether extension or upgrade, your new code needs to be compatible with data -that is already live in a production system. The next two sections show how to -extend and upgrade Daml models. The last section shows how to automate the data -migration process. diff --git a/docs/3.1/docs/upgrade/upgrade.rst b/docs/3.1/docs/upgrade/upgrade.rst index 70c10138c..5b8351588 100644 --- a/docs/3.1/docs/upgrade/upgrade.rst +++ b/docs/3.1/docs/upgrade/upgrade.rst @@ -9,6 +9,8 @@ Upgrading Daml Applications .. .. toctree:: :hidden: +An upgrade changes previously defined data structures and templates in your Daml model. + In applications backed by a centralized database controlled by a single operator, it is possible to upgrade an application in a single step that migrates all existing data to a new data model.