Skip to content

README.md

Latest commit

 

History

History
195 lines (151 loc) · 16.9 KB

README.md

File metadata and controls

195 lines (151 loc) · 16.9 KB

Edits

Overview

Available Operations

exportEditsDatabricksIntegrationsDatabricksEditsExportPost

Exports the resulting dataframe after a series of edits to databricks delta lake.

If overrides are provided, and the original edit had a task, the override MUST explicitly have a task set (typically the same task as the edit)

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.edits.exportEditsDatabricksIntegrationsDatabricksEditsExportPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    body: {
      editIds: [
        "<value 1>",
      ],
      databaseName: "<value>",
      tableName: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { integrationsExportEditsDatabricksIntegrationsDatabricksEditsExportPost } from "galileo-generated/funcs/integrationsExportEditsDatabricksIntegrationsDatabricksEditsExportPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await integrationsExportEditsDatabricksIntegrationsDatabricksEditsExportPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    body: {
      editIds: [
        "<value 1>",
      ],
      databaseName: "<value>",
      tableName: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("integrationsExportEditsDatabricksIntegrationsDatabricksEditsExportPost failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ExportEditsDatabricksIntegrationsDatabricksEditsExportPostRequest ✔️ The request object to use for the request.
security operations.ExportEditsDatabricksIntegrationsDatabricksEditsExportPostSecurity ✔️ The security requirements to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DatabricksEditExportResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

exportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost

Export Edits Databricks Unity Catalog

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.edits.exportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    body: {
      editIds: [
        "<value 1>",
        "<value 2>",
        "<value 3>",
      ],
      catalogName: "<value>",
      schemaName: "<value>",
      pslContentFileName: "<value>",
      tableName: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  integrationsExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost,
} from "galileo-generated/funcs/integrationsExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await integrationsExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    body: {
      editIds: [
        "<value 1>",
        "<value 2>",
        "<value 3>",
      ],
      catalogName: "<value>",
      schemaName: "<value>",
      pslContentFileName: "<value>",
      tableName: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("integrationsExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPost failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPostRequest ✔️ The request object to use for the request.
security operations.ExportEditsDatabricksUnityCatalogIntegrationsDatabricksUnityCatalogEditsExportPostSecurity ✔️ The security requirements to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DatabricksUnityCatalogExportEditsResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*