docs/Corporate actions source.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "mdt9",
   "metadata": {},
   "source": [
    "# Corporate actions source\n",
    "\n",
    "You can run the cells below directly in LUSID's JupyterHub.\n",
    "\n",
    "The `%%luminesce` is a magic command which passes the cell query string to Lumipy,\n",
    "which then returns a DataFrame.\n",
    "    "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "mds90",
   "metadata": {},
   "source": [
    "#### Create corporate action source"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ccs90",
   "metadata": {},
   "outputs": [],
   "source": [
    "%%luminesce\n",
    "\n",
    "/*\n",
    "\n",
    "-------------------------------\n",
    "Create Corporate Action Sources\n",
    "-------------------------------\n",
    "\n",
    "Description:\n",
    "\n",
    "    - In this query, we create a corporate action source in LUSID\n",
    "\n",
    "More details:\n",
    "\n",
    "    https://support.lusid.com/knowledgebase/article/KA-02066/en-us\n",
    "\n",
    "*/\n",
    "\n",
    "@@corporateActionSourceScope = select 'luminesce-examples';\n",
    "@@corporateActionSourceCode = select 'example-corp-act-source';\n",
    "\n",
    "/*\n",
    "\n",
    "Step 1: Define a table containing sample information.\n",
    "\n",
    "*/\n",
    "\n",
    "@corporate_action_source_table =\n",
    "select  \n",
    "\"Sample Action Source\" as DisplayName,\n",
    "\"Source description\" as Description,\n",
    "@@corporateActionSourceScope as CorporateActionSourceScope,\n",
    "@@corporateActionSourceCode as CorporateActionSourceCode,\n",
    "\"Insert\" as WriteAction;\n",
    "\n",
    "/*\n",
    "\n",
    "Step 2: Write the corporate action source to LUSID.\n",
    "\n",
    "*/\n",
    "\n",
    "select * \n",
    "from Lusid.CorporateAction.Source.Writer\n",
    "where ToWrite = @corporate_action_source_table;\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "mds91",
   "metadata": {},
   "source": [
    "#### Read corporate action source"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ccs91",
   "metadata": {},
   "outputs": [],
   "source": [
    "%%luminesce\n",
    "\n",
    "/*\n",
    "\n",
    "-----------------------------\n",
    "Read Corporate Action Sources\n",
    "-----------------------------\n",
    "\n",
    "Description:\n",
    "\n",
    "    - In this query, we read a corporate action source from LUSID.\n",
    "\n",
    "More details:\n",
    "\n",
    "    https://support.lusid.com/knowledgebase/article/KA-02065/en-us\n",
    "\n",
    "*/\n",
    "\n",
    "@@corporateActionSourceScope = select 'luminesce-examples';\n",
    "@@corporateActionSourceCode = select 'example-corp-act-source';\n",
    "\n",
    "\n",
    "/*\n",
    "\n",
    "Step 1: Retrieve corresponding corporate action source from LUSID.\n",
    "\n",
    "*/\n",
    "\n",
    "select * \n",
    "from Lusid.CorporateAction.Source\n",
    "where CorporateActionSourceScope=@@corporateActionSourceScope\n",
    "and CorporateActionSourceCode=@@corporateActionSourceCode\n"
   ]
  }
 ],
 "metadata": {},
 "nbformat": 4,
 "nbformat_minor": 5
}