Create a dataset

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Creates a new dataset.

Path Parameters

namespace string required

Possible values: <= 1024 characters

The name of the namespace.

dataset string required

Possible values: <= 1024 characters

The name of the dataset.

application/json

Request Body

anyOf

DbTable

Stream

---

type string required

Possible values: [DB_TABLE]

The type of the dataset.

physicalName string required

The physical name of the table.

sourceName string required

The name of the source associated with the table.

fields object[] required

The fields of the table.

Array [

name string required

The name of the field.

type string required

The data type of the field.

tags string

List of tags.

description string

The description of the field.

]

tags string[]

List of tags.

description string

The description of the table.

runId string

The ID associated with the run modifying the table.

type string required

Possible values: [STREAM]

The type of the dataset.

physicalName string required

The physical name of the stream.

sourceName string required

The name of the source associated with the stream.

schemaLocation string required

The URL of the schema for the stream data.

fields object[] required

The schema fields for the stream data.

Array [

name string required

The name of the field.

type string required

The type of the field.

tags string[]

List of tags.

description string

The description of the field.

]

tags string[]

List of tags.

description string

The description of the stream.

runId string

The ID associated with the run modifying the stream.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

id object

The ID of the dataset.

namespace string

The namespace of the dataset.

name string

The name of the dataset.

type string

The type of the dataset.

name string

The logical name of the dataset.

physicalName string

The physical name of the dataset.

createdAt date-time

An ISO-8601 timestamp representing the date/time the dataset was created.

updatedAt date-time

An ISO-8601 timestamp representing the date/time the dataset was updated.

namespace string

The namespace of the dataset.

sourceName string

The name of the source associated with the dataset.

fields object[]
The fields of the dataset.
Array [
name string required
The name of the field.
type string required
The data type of the field.
tags string[]
List of tags.
description string
The description of the field.
]
tags string[]

List of tags.

lastModifiedAt date-time

An ISO-8601 timestamp representing the date/time the dataset was last modified by a successful run.

lastLifecycleState string

The last lifecycle state of the dataset.

description string

The description of the dataset.

facets object
The facets of the dataset. For a full list of standard dataset facets, see OpenLineage.
description
allOf
title
currentVersion uuid

The current version of the dataset.

deleted boolean

The deleted state of the dataset.

{
  "id": {
    "namespace": "my-namespace",
    "name": "my-dataset"
  },
  "type": "DB_TABLE",
  "name": "my-dataset",
  "physicalName": "public.mytable",
  "createdAt": "2019-05-09T19:49:24.201361Z",
  "updatedAt": "2019-05-09T19:49:24.201361Z",
  "namespace": "my-namespace",
  "sourceName": "my-source",
  "fields": [
    {
      "name'": "a",
      "type": "INTEGER",
      "tags": []
    },
    {
      "name'": "b",
      "type": "TIMESTAMP",
      "tags": []
    },
    {
      "name'": "c",
      "type": "INTEGER",
      "tags": []
    },
    {
      "name'": "d",
      "type": "INTEGER",
      "tags": []
    }
  ],
  "tags": [],
  "lastModifiedAt": null,
  "description": "My first dataset!",
  "facets": {},
  "currentVersion": "b1d626a2-6d3a-475e-9ecf-943176d4a8c6"
}

PUT /namespaces/:namespace/datasets/:dataset

Request

Base URL

http://localhost:5000/api/v1

namespace — path required

dataset — path required

Body

{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}

curl / cURL

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

python / requests

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

go / native

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

nodejs / axios

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

ruby / Net::HTTP

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

csharp / RestSharp

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

php / cURL

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

java / OkHttp

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'

powershell / RestMethod

curl -L -X PUT 'http://localhost:5000/api/v1/namespaces/:namespace/datasets/:dataset' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "type": "DB_TABLE",
  "physicalName": "public.mytable",
  "sourceName": "my-source",
  "fields": [
    {
      "name": "a",
      "type": "INTEGER"
    },
    {
      "name": "b",
      "type": "TIMESTAMP"
    },
    {
      "name": "c",
      "type": "INTEGER"
    },
    {
      "name": "d",
      "type": "INTEGER"
    }
  ],
  "description": "My first dataset!"
}'