opendistro-for-elasticsearch · dai-chen · Jul 21, 2020 · Jul 19, 2020 · Jul 19, 2020 · Jul 20, 2020
diff --git a/sql-odbc/.gitignore b/sql-odbc/.gitignore
@@ -56,3 +56,5 @@ CPackSourceConfig.cmake
 CTestTestfile.cmake
 /sdk-build64/
 /cmake-build64/
+/src/PowerBIConnector/bin/Debug/
+/src/PowerBIConnector/obj/
diff --git a/sql-odbc/docs/user/img/pbi_auth.png b/sql-odbc/docs/user/img/pbi_auth.png
diff --git a/sql-odbc/docs/user/img/pbi_connection_string_options.png b/sql-odbc/docs/user/img/pbi_connection_string_options.png
diff --git a/sql-odbc/docs/user/img/pbi_data_preview.png b/sql-odbc/docs/user/img/pbi_data_preview.png
diff --git a/sql-odbc/docs/user/img/pbi_select_connector.png b/sql-odbc/docs/user/img/pbi_select_connector.png
diff --git a/sql-odbc/docs/user/img/pbi_settings.png b/sql-odbc/docs/user/img/pbi_settings.png
diff --git a/sql-odbc/docs/user/img/pbi_third_party_warning.png b/sql-odbc/docs/user/img/pbi_third_party_warning.png
diff --git a/sql-odbc/docs/user/power_bi_support.md b/sql-odbc/docs/user/power_bi_support.md
@@ -0,0 +1,43 @@
+# Microsoft Power BI Desktop
+
+**NOTE**: **The connector is under development. All connection options are not available yet. There could be issues while loading data**
+
+## Prerequisites
+* Microsoft Power BI Desktop
+* [Open Distro for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/install/)
+* [Open Distro for Elasticsearch SQL ODBC driver](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/odbc/)
+* [OdfeSqlOdbcPBIConnector.mez](../../src/PowerBIConnector/bin/Release/) 
+
+## Setup
+* Copy `OdfeSqlOdbcPBIConnector.mez` file in the `<User>\Documents\Power BI Desktop\Custom Connectors\` folder. This will let Power BI access custom connector.
+* Open Power BI Desktop.
+* Change the security settings. Click on **Files** > **Options and settings** > **Options** > **Security** > Select **Allow any extension to load without validation or warning** for Data Extensions. This will allow the custom connector to load data into Power BI.
+
+<img src="img/pbi_settings.png" width="500">
+
+* Restart Power BI Desktop.
+
+## Load Data
+
+* Open Power BI Desktop.
+* Click on **Home** > **Get Data** > **More** > **Other**. Select **Open Distro For Elasticsearch (Beta)**. Click on **Connect**.
+
+<img src="img/pbi_select_connector.png" width="500">
+
+* You will get a warning for using third-party service. Click on **Continue**.
+
+<img src="img/pbi_third_party_warning.png" width="500">
+
+* Enter host and port values. Click on **OK**.
+
+<img src="img/pbi_connection_string_options.png" width="500">
+
+* Select authentication option and click on **Connect**.
+
+<img src="img/pbi_auth.png" width="500">
+
+* Select required table. Data preview will be loaded.
+
+<img src="img/pbi_data_preview.png">
+
+* Click on **Load**.
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.mproj b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.mproj
@@ -0,0 +1,117 @@
+<Project DefaultTargets="BuildExtension" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{75a2dabe-6c5b-498e-8df1-e85d4483a7dc}</ProjectGuid>
+    <OutputType>Exe</OutputType>
+    <RootNamespace>MyRootNamespace</RootNamespace>
+    <AssemblyName>MyAssemblyName</AssemblyName>
+    <EnableUnmanagedDebugging>False</EnableUnmanagedDebugging>
+    <AllowNativeQuery>False</AllowNativeQuery>
+    <AsAction>False</AsAction>
+    <FastCombine>False</FastCombine>
+    <ClearLog>False</ClearLog>
+    <ShowEngineTraces>False</ShowEngineTraces>
+    <ShowUserTraces>False</ShowUserTraces>
+    <LegacyRedirects>False</LegacyRedirects>
+    <SuppressRowErrors>False</SuppressRowErrors>
+    <SuppressCellErrors>False</SuppressCellErrors>
+    <MaxRows>1000</MaxRows>
+    <ExtensionProject>Yes</ExtensionProject>
+    <Name>OdfeSqlOdbcPBIConnector</Name>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+    <DebugSymbols>false</DebugSymbols>
+    <!--Should be true, fix this when the debugger is implemented -->
+    <OutputPath>bin\Debug\</OutputPath>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+    <DebugSymbols>false</DebugSymbols>
+    <OutputPath>bin\Release\</OutputPath>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="mscorlib" />
+    <Reference Include="System" />
+    <Reference Include="System.Data" />
+    <Reference Include="System.Xml" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="OdfeSqlOdbcPBIConnector.pq">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector16.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector20.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector24.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector32.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector40.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector48.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector64.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="OdfeSqlOdbcPBIConnector80.png">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="resources.resx">
+      <SubType>Code</SubType>
+    </Compile>
+    <Content Include="OdfeSqlOdbcPBIConnector.query.pq">
+      <SubType>Code</SubType>
+    </Content>
+  </ItemGroup>
+  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
+  <UsingTask TaskName="BuildExtension" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v12.0.dll">
+    <ParameterGroup>
+      <InputDirectory ParameterType="System.String" Required="true" />
+      <OutputFile ParameterType="System.String" Required="true" />
+    </ParameterGroup>
+    <Task>
+      <Reference Include="System.IO.Compression" />
+      <Reference Include="System.IO.Compression.FileSystem" />
+      <Using Namespace="System.Globalization" />
+      <Using Namespace="System.IO.Compression " />
+      <Code Type="Fragment" Language="cs"><![CDATA[    
+    using(FileStream fileStream = File.Create(OutputFile))
+    using(ZipArchive archiveOut = new ZipArchive(fileStream, ZipArchiveMode.Create, false))
+    {
+        foreach(string fullPath in Directory.EnumerateFiles(InputDirectory))
+        {
+            string filename = Path.GetFileName(fullPath);
+
+            archiveOut.CreateEntryFromFile(fullPath, filename, CompressionLevel.Optimal);
+        }
+    }
+]]></Code>
+    </Task>
+  </UsingTask>
+  <Target Name="BuildExtension" DependsOnTargets="ExtensionClean">
+    <ItemGroup>
+      <PQFiles Include="@(Compile)" Condition="'%(Extension)' == '.pq'" />
+    </ItemGroup>
+    <ItemGroup>
+      <NonPQFiles Include="@(Compile)" Condition="'%(Extension)' != '.pq'" />
+    </ItemGroup>
+    <MakeDir Directories="$(IntermediateOutputPath)" />
+    <MakeDir Directories="$(OutputPath)" />
+    <Copy SourceFiles="@(NonPQFiles)" DestinationFolder="$(IntermediateOutputPath)" />
+    <Copy SourceFiles="@(PQFiles)" DestinationFiles="@(PQFiles->'$(IntermediateOutputPath)%(RecursiveDir)%(FileName).m')" />
+    <BuildExtension InputDirectory="$(IntermediateOutputPath)" OutputFile="$(OutputPath)\$(ProjectName).mez" />
+  </Target>
+  <Target Name="ExtensionClean">
+    <!-- Remove obj folder -->
+    <RemoveDir Directories="$(BaseIntermediateOutputPath)" />
+    <!-- Remove bin folder -->
+    <RemoveDir Directories="$(OutputPath)" />
+  </Target>
+</Project>
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq
@@ -0,0 +1,56 @@
+// This file contains your Data Connector logic
+section OdfeSqlOdbcPBIConnector;
+
+[DataSource.Kind="OdfeSqlOdbcPBIConnector", Publish="OdfeSqlOdbcPBIConnector.Publish"]
+shared OdfeSqlOdbcPBIConnector.Contents = Value.ReplaceType(OdfeSqlOdbcPBIConnectorImpl, OdfeSqlOdbcPBIConnectorType); 
+
+// Wrapper function to provide additional UI customization.
+OdfeSqlOdbcPBIConnectorType = type function (
+        Host as (type text meta [
+            Documentation.FieldCaption = "Host",
+            Documentation.FieldDescription = "The hostname of the Open Distro For Elasticsearc server.",
+            Documentation.SampleValues = { "localhost" }
+        ]),
+        Port as (type number meta [
+            Documentation.FieldCaption = "Port",
+            Documentation.FieldDescription = "The port the Open Distro For Elasticsearc server is running on.",
+            Documentation.SampleValues = { 9200 }
+        ])
+    )
+    as table meta [
+        Documentation.Name = "Open Distro For Elasticsearch"
+    ];
+
+OdfeSqlOdbcPBIConnectorImpl = (Host as text, Port as number) as table =>
+    let
+        ConnectionString = [
+            Driver = "ODFE SQL ODBC Driver",
+            Host = Host,
+            Port = Port
+        ],
+        OdbcDatasource = Odbc.DataSource(ConnectionString)
+    in
+        OdbcDatasource;
+
+// Data Source Kind description
+OdfeSqlOdbcPBIConnector = [
+    Authentication = [
+        Implicit = []
+    ],
+    Label = Extension.LoadString("DataSourceLabel")
+];
+
+// Data Source UI publishing description
+OdfeSqlOdbcPBIConnector.Publish = [
+    Beta = true,
+    Category = "Other",
+    ButtonText = { Extension.LoadString("ButtonTitle"), Extension.LoadString("ButtonHelp") },
+    LearnMoreUrl = "https://opendistro.github.io/for-elasticsearch/",
+    SourceImage = OdfeSqlOdbcPBIConnector.Icons,
+    SourceTypeImage = OdfeSqlOdbcPBIConnector.Icons
+];
+
+OdfeSqlOdbcPBIConnector.Icons = [
+    Icon16 = { Extension.Contents("OdfeSqlOdbcPBIConnector16.png"), Extension.Contents("OdfeSqlOdbcPBIConnector20.png"), Extension.Contents("OdfeSqlOdbcPBIConnector24.png"), Extension.Contents("OdfeSqlOdbcPBIConnector32.png") },
+    Icon32 = { Extension.Contents("OdfeSqlOdbcPBIConnector32.png"), Extension.Contents("OdfeSqlOdbcPBIConnector40.png"), Extension.Contents("OdfeSqlOdbcPBIConnector48.png"), Extension.Contents("OdfeSqlOdbcPBIConnector64.png") }
+];
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.query.pq b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.query.pq
@@ -0,0 +1,5 @@
+// Use this file to write queries to test your data connector
+let
+    result = OdfeSqlOdbcPBIConnector.Contents()
+in
+    result
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector16.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector16.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector20.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector20.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector24.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector24.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector32.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector32.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector40.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector40.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector48.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector48.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector64.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector64.png
diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector80.png b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector80.png
diff --git a/sql-odbc/src/PowerBIConnector/bin/Release/OdfeSqlOdbcPBIConnector.mez b/sql-odbc/src/PowerBIConnector/bin/Release/OdfeSqlOdbcPBIConnector.mez
diff --git a/sql-odbc/src/PowerBIConnector/resources.resx b/sql-odbc/src/PowerBIConnector/resources.resx
@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!-- 
+    Microsoft ResX Schema 
+
+    Version 2.0
+
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+
+    Example:
+
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="ButtonHelp" xml:space="preserve">
+    <value>Connect to Open Distro For Elasticsearch</value>
+  </data>
+  <data name="ButtonTitle" xml:space="preserve">
+    <value>Open Distro For Elasticsearch</value>
+  </data>
+  <data name="DataSourceLabel" xml:space="preserve">
+    <value>Open Distro For Elasticsearch</value>
+  </data>
+</root>