Initial pass

docs/index.rst

@@ -65,5 +65,6 @@ Contents
    testing_plugins
    internals
    events
+   upgrade_guide_v1
    contributing
    changelog

docs/upgrade_guide_v1.rst

@@ -0,0 +1,74 @@
+.. upgrade_guide_v1:
+
+============
+ Datasete 0.X -> 1.0 Upgrade Guide
+============
+
+
+This document specifically reviews what breaking changes Datasette `1.0` has when upgrading from a `0.XX` version. For new features that `1.0` offers, see the [Changelog](#TODO).
+
+
+Metadata changes
+================
+
+Metadata in Datasette.10 was completely revamped. There are a number of related breaking changes, from the `metadata.yaml` file to Python APIs that you'll need to consider when upgrading.
+
+`metadata.yaml` split into `datasette.yaml`
+---------
+
+Before Datasette 1.0, the `metadata.yaml` file became a kitchen sink if a mix of metadata, configuration, and settings. Now `metadata.yaml`
+
+Metadata "fallback" has been removed
+---------
+
+The `get_metadata()` Plugin hook has been removed
+---------
+
+As of Datasette `1.0a14` (2024-XX-XX), the `get_metadata()` hook has been deprecated.
+
+.. code-block:: python
+
+    # ❌ DEPRECATED in Datasette 1.0
+    @hookimpl
+    def get_metadata(datasette, key, database, table):
+        pass
+
+Instead, one should use the following methods on a Datasette class:
+
+- [`.get_instance_metadata()`](#TODO) and [`.set_instance_metadata()`](#TODO)
+- [`.get_database_metadata()`](#TODO) and [`.set_database_metadata()`](#TODO)
+- [`.get_resource_metadata()`](#TODO) and [`.set_resource_metadata()`](#TODO)
+- [`.get_column_metadata()`](#TODO) and [`.set_column_metadata()`](#TODO)
+
+The `/metadata.json` endpoint has been removed
+---------
+
+As of Datasette `1.0a14` (2024-XX-XX), the
+
+The `metadata()` method on the Datasette class has been removed
+---------
+
+As of Datasette `1.0a14` (2024-XX-XX), the
+
+
+New endpoint for SQL queries
+=====
+
+Previously, if you wanted to run SQL code using the Datasette HTTP API, you could call an endpoint that looked like:
+
+::
+
+    # DEPRECATED: Older endpoint for Datasette 0.XX
+    curl http://localhost:8001/_memory?sql=select+123
+
+However, in Datasette 1.0, the endpoint wasn slightly changed to:
+
+
+::
+
+    # ✅ Datasette 1.0 and beyond
+    curl http://localhost:8001/_memory/-/query?sql=select+123
+
+Specifically, now there's a `/-/query` "action" that should be used.
+
+**This isn't a breaking change.** API calls to the older `/database?sql=...` endpoint will redirect to the new `database/-/query?sql=...` endpoint. However, documentations and example will use the new query endpoint, so it is recommended to use that instead.