SingleStore OCF Connector: Overview¶
Alation Cloud Service Applies to Alation Cloud Service instances of Alation
Customer Managed Applies to customer-managed instances of Alation
Overview¶
The OCF connector for SingleStore (former MemSQL) was developed by Alation and is available on demand as a Zip file. Contact Alation Support about receiving the connector package.
This connector should be used to catalog SingleStore as a data source in Alation. The connector catalogs SingleStore objects such as tables, columns, views, primary and foreign keys, functions, and function definitions. It enables end-users to search and find SingleStore objects from the Alation user interface.
Team¶
The following administrators are required to install this connector:
Alation administrator:
Install the connector.
Creates and configures a SingleStore data source in the catalog.
SingleStore administrator:
Creates a service account for Alation and grants it the required privileges, providing access to schemas to extract metadata
Provides the JDBC URI.
Provides access to the schemas to extract metadata.
Scope¶
The table below describes which metadata objects are extracted by the connector and which catalog functionality is supported.
Feature |
Scope |
Availability |
|---|---|---|
Authentication |
||
Basic authentication |
Authentication with a service account that uses a username and password |
Yes |
LDAP |
Authentication with an LDAP user account |
No |
SSL |
Database connection over SSL |
No |
Kerberos |
Authentication with Kerberos |
No |
Keytab |
Authentication with keytab |
No |
SSL |
SSL authentication |
No |
Metadata Extraction (MDE) |
||
Default MDE |
Extraction of supported metadata objects based on default extraction queries in the connector code |
Yes |
Custom query-based MDE |
Extraction of supported metadata objects based on extraction queries provided by the user |
No |
Extracted metadata objects |
||
Data source |
Data source object in Alation that is parent to the extracted metadata |
Yes |
Schemas |
List of schemas |
Yes |
Tables |
List of tables |
Yes |
Columns |
List of columns |
Yes |
Column data types |
Column data types |
No |
Views |
List of views |
Yes |
Source comments |
Source comments |
Yes* |
Primary keys |
Primary key information for extracted tables |
Yes |
Foreign keys |
Foreign key information for extracted tables |
Yes |
Functions |
Extract function metadata |
Yes |
Function definitions |
Extract function definition metadata |
Yes |
Sampling and Profiling |
||
Table sampling |
Extracts data samples from all extracted tables |
Yes |
Column sampling |
Extracts data samples from all extracted columns |
Yes |
Deep column profiling |
On-demand profiling of specific columns with the calculation of value distribution stats |
Yes |
Dynamic profiling |
On-demand table and column profiling by individual users who use their own database account to retrieve the profiles |
Yes |
Custom query-based table sampling |
Ability to use custom queries for sampling specific tables |
Yes |
Custom query-based column sampling |
Ability to use custom queries for profiling specific columns |
Yes |
Query Log Ingestion (QLI) |
||
Query-based QLI |
Ingestion of query history based on a custom query history extraction query |
No |
JOINs and filters |
Calculation of JOIN and filter information based on ingested query history |
No |
Predicates |
Ability to parse predicates in ingested queries |
No |
Lineage |
||
Automatic lineage generation |
Auto-calculation of lineage based on ingested query history |
Yes** |
Column-level lineage |
Calculation of lineage at column level |
No |
Compose |
||
Customer-managed (on-prem) Alation instances |
Compose on on-prem Alation instances |
Yes |
Alation Cloud Service instances, connection via Agent |
Compose on Alation Cloud Service instances: depending on your network configuration, you may be using Alation Agent to connect to your data source. Compose via Agent is supported from connector version 1.1.0.4908. |
Yes |
Compose authentication |
Authentication in Compose with username and password (basic authentication) |
Yes |
* Schema source comment extraction is not supported. Only table and column source comment extraction is supported.
** Lineage is calculated based on queries ingested from Compose.