semantic-link-labs 0.8.4__tar.gz → 0.8.5__tar.gz

{semantic_link_labs-0.8.4 → semantic_link_labs-0.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: semantic-link-labs
-Version: 0.8.4
+Version: 0.8.5
 Summary: Semantic Link Labs for Microsoft Fabric
 Author: Microsoft Corporation
 License: MIT License
@@ -15,7 +15,7 @@ Classifier: Framework :: Jupyter
 Requires-Python: <3.12,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: semantic-link-sempy>=0.8.1
+Requires-Dist: semantic-link-sempy>=0.8.3
 Requires-Dist: anytree
 Requires-Dist: powerbiclient
 Requires-Dist: polib
@@ -27,7 +27,7 @@ Requires-Dist: pytest>=8.2.1; extra == "test"
 # Semantic Link Labs
 
 [![PyPI version](https://badge.fury.io/py/semantic-link-labs.svg)](https://badge.fury.io/py/semantic-link-labs)
-[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.4&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
+[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.5&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/semantic-link-labs)](https://pepy.tech/project/semantic-link-labs)
 
@@ -41,6 +41,10 @@ If you encounter any issues, please [raise a bug](https://github.com/microsoft/s
 
 If you have ideas for new features/functions, please [request a feature](https://github.com/microsoft/semantic-link-labs/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=).
 
+Check out the video below for an introduction to Semantic Link, Semantic Link Labs and demos of key features!
+
+[![Semantic Link Labs Video](https://img.youtube.com/vi/LSoWDEZk9b0/0.jpg)](https://www.youtube.com/watch?v=LSoWDEZk9b0)
+
 ## Featured Scenarios
 * Semantic Models
     * [Migrating an import/DirectQuery semantic model to Direct Lake](https://github.com/microsoft/semantic-link-labs?tab=readme-ov-file#direct-lake-migration)
@@ -130,6 +134,7 @@ An even better way to ensure the semantic-link-labs library is available in your
 2. Select your newly created environment within the 'Environment' drop down in the navigation bar at the top of the notebook
 
 ## Version History
+* [0.8.5](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.5) (November 13, 2024)
 * [0.8.4](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.4) (October 30, 2024)
 * [0.8.3](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.3) (October 14, 2024)
 * [0.8.2](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.2) (October 2, 2024)

{semantic_link_labs-0.8.4 → semantic_link_labs-0.8.5}/README.md

@@ -1,7 +1,7 @@
 # Semantic Link Labs
 
 [![PyPI version](https://badge.fury.io/py/semantic-link-labs.svg)](https://badge.fury.io/py/semantic-link-labs)
-[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.4&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
+[![Read The Docs](https://readthedocs.org/projects/semantic-link-labs/badge/?version=0.8.5&style=flat)](https://readthedocs.org/projects/semantic-link-labs/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://static.pepy.tech/badge/semantic-link-labs)](https://pepy.tech/project/semantic-link-labs)
 
@@ -15,6 +15,10 @@ If you encounter any issues, please [raise a bug](https://github.com/microsoft/s
 
 If you have ideas for new features/functions, please [request a feature](https://github.com/microsoft/semantic-link-labs/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=).
 
+Check out the video below for an introduction to Semantic Link, Semantic Link Labs and demos of key features!
+
+[![Semantic Link Labs Video](https://img.youtube.com/vi/LSoWDEZk9b0/0.jpg)](https://www.youtube.com/watch?v=LSoWDEZk9b0)
+
 ## Featured Scenarios
 * Semantic Models
     * [Migrating an import/DirectQuery semantic model to Direct Lake](https://github.com/microsoft/semantic-link-labs?tab=readme-ov-file#direct-lake-migration)
@@ -104,6 +108,7 @@ An even better way to ensure the semantic-link-labs library is available in your
 2. Select your newly created environment within the 'Environment' drop down in the navigation bar at the top of the notebook
 
 ## Version History
+* [0.8.5](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.5) (November 13, 2024)
 * [0.8.4](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.4) (October 30, 2024)
 * [0.8.3](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.3) (October 14, 2024)
 * [0.8.2](https://github.com/microsoft/semantic-link-labs/releases/tag/0.8.2) (October 2, 2024)

{semantic_link_labs-0.8.4 → semantic_link_labs-0.8.5}/docs/source/conf.py

@@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath('../../src/'))
 project = 'semantic-link-labs'
 copyright = '2024, Microsoft and community'
 author = 'Microsoft and community'
-release = '0.8.4'
+release = '0.8.5'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

{semantic_link_labs-0.8.4 → semantic_link_labs-0.8.5}/environment.yml

@@ -6,7 +6,7 @@ dependencies:
 - pytest-cov
 - pytest-mock
 - pip:
-  - semantic-link-sempy>=0.8.1
+  - semantic-link-sempy>=0.8.3
   - azure-identity==1.7.1
   - azure-storage-blob>=12.9.0
   - pandas-stubs

semantic_link_labs-0.8.5/notebooks/Migration to Direct Lake.ipynb

@@ -0,0 +1,387 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "a024bb09",
+   "metadata": {},
+   "source": [
+    "### Watch thie video below to see a walkthrough of the Direct Lake Migration process\n",
+    "[![Direct Lake Migration Video](https://img.youtube.com/vi/gGIxMrTVyyI/0.jpg)](https://www.youtube.com/watch?v=gGIxMrTVyyI?t=495)\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5c27dfd1-4fe0-4a97-92e6-ddf78889aa93",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Install the latest .whl package\n",
+    "\n",
+    "Check [here](https://pypi.org/project/semantic-link-labs/) to see the latest version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d5cae9db-cef9-48a8-a351-9c5fcc99645c",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": true,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "%pip install semantic-link-labs"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "969a29bf",
+   "metadata": {},
+   "source": [
+    "### Import the library and set initial parameters"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "29c923f8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sempy_labs as labs\n",
+    "from sempy_labs import migration, directlake\n",
+    "import sempy_labs.report as rep\n",
+    "\n",
+    "dataset_name = '' #Enter the import/DQ semantic model name\n",
+    "workspace_name = None #Enter the workspace of the import/DQ semantic model. It set to none it will use the current workspace.\n",
+    "new_dataset_name = '' #Enter the new Direct Lake semantic model name\n",
+    "new_dataset_workspace_name = None #Enter the workspace where the Direct Lake model will be created. If set to None it will use the current workspace.\n",
+    "lakehouse_name = None #Enter the lakehouse to be used for the Direct Lake model. If set to None it will use the lakehouse attached to the notebook.\n",
+    "lakehouse_workspace_name = None #Enter the lakehouse workspace. If set to None it will use the new_dataset_workspace_name."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5a3fe6e8-b8aa-4447-812b-7931831e07fe",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Create the [Power Query Template](https://learn.microsoft.com/power-query/power-query-template) file\n",
+    "\n",
+    "This encapsulates all of the semantic model's Power Query logic into a single file."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "cde43b47-4ecc-46ae-9125-9674819c7eab",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": false,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "migration.create_pqt_file(dataset = dataset_name, workspace = workspace_name)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bf945d07-544c-4934-b7a6-cfdb90ca725e",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Import the Power Query Template to Dataflows Gen2\n",
+    "\n",
+    "- Open the [OneLake file explorer](https://www.microsoft.com/download/details.aspx?id=105222) and sync your files (right click -> Sync from OneLake)\n",
+    "\n",
+    "- Navigate to your lakehouse. From this window, create a new Dataflows Gen2 and import the Power Query Template file from OneLake (OneLake -> Workspace -> Lakehouse -> Files...), and publish the Dataflows Gen2.\n",
+    "\n",
+    "<div class=\"alert alert-block alert-info\">\n",
+    "<b>Important!</b> Make sure to create the Dataflows Gen2 from within the lakehouse window. That will ensure that all the tables automatically map to that lakehouse as the destination. Otherwise, you will have to manually map each table to its destination individually.\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9975db7d",
+   "metadata": {},
+   "source": [
+    "### Create the Direct Lake model based on the import/DQ semantic model\n",
+    "\n",
+    "Calculated columns are not migrated to the Direct Lake model as they are not supported in Direct Lake mode."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0a3616b5-566e-414e-a225-fb850d6418dc",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": false,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "import time\n",
+    "labs.create_blank_semantic_model(dataset = new_dataset_name, workspace = new_dataset_workspace_name, overwrite=False)\n",
+    "\n",
+    "migration.migrate_calc_tables_to_lakehouse(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    workspace=workspace_name,\n",
+    "    new_dataset_workspace=new_dataset_workspace_name,\n",
+    "    lakehouse=lakehouse_name,\n",
+    "    lakehouse_workspace=lakehouse_workspace_name\n",
+    ")\n",
+    "migration.migrate_tables_columns_to_semantic_model(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    workspace=workspace_name,\n",
+    "    new_dataset_workspace=new_dataset_workspace_name,\n",
+    "    lakehouse=lakehouse_name,\n",
+    "    lakehouse_workspace=lakehouse_workspace_name\n",
+    ")\n",
+    "migration.migrate_calc_tables_to_semantic_model(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    workspace=workspace_name,\n",
+    "    new_dataset_workspace=new_dataset_workspace_name,\n",
+    "    lakehouse=lakehouse_name,\n",
+    "    lakehouse_workspace=lakehouse_workspace_name\n",
+    ")\n",
+    "migration.migrate_model_objects_to_semantic_model(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    workspace=workspace_name,\n",
+    "    new_dataset_workspace=new_dataset_workspace_name\n",
+    ")\n",
+    "migration.migrate_field_parameters(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    workspace=workspace_name,\n",
+    "    new_dataset_workspace=new_dataset_workspace_name\n",
+    ")\n",
+    "time.sleep(2)\n",
+    "labs.refresh_semantic_model(dataset=new_dataset_name, workspace=new_dataset_workspace_name)\n",
+    "migration.refresh_calc_tables(dataset=new_dataset_name, workspace=new_dataset_workspace_name)\n",
+    "labs.refresh_semantic_model(dataset=new_dataset_name, workspace=new_dataset_workspace_name)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bb98bb13",
+   "metadata": {},
+   "source": [
+    "### Show migrated/unmigrated objects"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5db2f22c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "migration.migration_validation(\n",
+    "    dataset=dataset_name,\n",
+    "    new_dataset=new_dataset_name, \n",
+    "    workspace=workspace_name, \n",
+    "    new_dataset_workspace=new_dataset_workspace_name\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "fa244e9d-87c2-4a66-a7e0-be539a0ac7de",
+   "metadata": {
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "### Rebind all reports using the old semantic model to the new Direct Lake semantic model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d4e867cc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "rep.report_rebind_all(\n",
+    "    dataset=dataset_name,\n",
+    "    dataset_workspace=workspace_name,\n",
+    "    new_dataset=new_dataset_name,\n",
+    "    new_dataset_workpace=new_dataset_workspace_name,\n",
+    "    report_workspace=None\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3365d20d",
+   "metadata": {},
+   "source": [
+    "### Rebind reports one-by-one (optional)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "056b7180-d7ac-492c-87e7-ac7d0e4bb929",
+   "metadata": {
+    "jupyter": {
+     "outputs_hidden": false,
+     "source_hidden": false
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "outputs": [],
+   "source": [
+    "report_name = '' # Enter report name which you want to rebind to the new Direct Lake model\n",
+    "\n",
+    "rep.report_rebind(\n",
+    "    report=report_name,\n",
+    "    dataset=new_dataset_name,\n",
+    "    report_workspace=workspace_name,\n",
+    "    dataset_workspace=new_dataset_workspace_name)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "526f2327",
+   "metadata": {},
+   "source": [
+    "### Show unsupported objects"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a47376d7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dfT, dfC, dfR = directlake.show_unsupported_direct_lake_objects(dataset = dataset_name, workspace = workspace_name)\n",
+    "\n",
+    "print('Calculated Tables are not supported...')\n",
+    "display(dfT)\n",
+    "print(\"Learn more about Direct Lake limitations here: https://learn.microsoft.com/power-bi/enterprise/directlake-overview#known-issues-and-limitations\")\n",
+    "print('Calculated columns are not supported. Columns of binary data type are not supported.')\n",
+    "display(dfC)\n",
+    "print('Columns used for relationship must be of the same data type.')\n",
+    "display(dfR)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ed08ba4c",
+   "metadata": {},
+   "source": [
+    "### Schema check between semantic model tables/columns and lakehouse tables/columns\n",
+    "\n",
+    "This will list any tables/columns which are in the new semantic model but do not exist in the lakehouse"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "03889ba4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "directlake.direct_lake_schema_compare(dataset=new_dataset_name, workspace=new_dataset_workspace_name)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2229963b",
+   "metadata": {},
+   "source": [
+    "### Show calculated tables which have been migrated to the Direct Lake semantic model as regular tables"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "dd537d90",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "directlake.list_direct_lake_model_calc_tables(dataset=new_dataset_name, workspace=new_dataset_workspace_name)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernel_info": {
+   "name": "synapse_pyspark"
+  },
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.3"
+  },
+  "microsoft": {
+   "language": "python"
+  },
+  "nteract": {
+   "version": "nteract-front-end@1.0.0"
+  },
+  "spark_compute": {
+   "compute_id": "/trident/default"
+  },
+  "synapse_widget": {
+   "state": {},
+   "version": "0.1"
+  },
+  "widgets": {}
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}