"use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { a: "a", blockquote: "blockquote", code: "code", div: "div", em: "em", h1: "h1", h2: "h2", h3: "h3", h4: "h4", h5: "h5", h6: "h6", li: "li", p: "p", path: "path", pre: "pre", span: "span", strong: "strong", svg: "svg", table: "table", tbody: "tbody", td: "td", th: "th", thead: "thead", tr: "tr", ul: "ul", ..._provideComponents(), ...props.components }; return _jsxs(_Fragment, { children: [_jsxs(_components.h1, { id: "ckan-client-guide", children: [_jsx(_components.a, { className: "heading-link", href: "#ckan-client-guide", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "CKAN Client Guide"] }), "\n", _jsxs(_components.p, { children: ["Guide to interacting with ", _jsx(_components.a, { href: "/dms/ckan", children: "CKAN" }), " for power users such as data scientists, data engineers and data wranglers."] }), "\n", _jsx(_components.p, { children: "This guide is about adding and managing data in CKAN programmatically and it assumes:" }), "\n", _jsxs(_components.ul, { children: ["\n", _jsx(_components.li, { children: "You are familiar with key concepts like metadata, data, etc." }), "\n", _jsxs(_components.li, { children: ["You are working programmatically with a programming language such as Python, JavaScript or R (", _jsx(_components.em, { children: "coming soon" }), ")."] }), "\n"] }), "\n", _jsxs(_components.h2, { id: "frictionless-formats", children: [_jsx(_components.a, { className: "heading-link", href: "#frictionless-formats", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Frictionless Formats"] }), "\n", _jsxs(_components.p, { children: ["Clients use ", _jsx(_components.a, { href: "https://specs.frictionlessdata.io/", target: "_blank", rel: "noopener noreferrer", children: "Frictionless formats" }), " by default for describing dataset and resource objects passed to client methods. Internally, we then use the a ", _jsxs(_components.em, { children: ["CKAN ", '<=>', " Frictionless Mapper"] }), " (both ", _jsx(_components.a, { href: "https://github.com/datopian/frictionless-ckan-mapper-js", target: "_blank", rel: "noopener noreferrer", children: "in JavaScript" }), " and ", _jsx(_components.a, { href: "https://github.com/frictionlessdata/frictionless-ckan-mapper", target: "_blank", rel: "noopener noreferrer", children: "in Python" }), ") to convert objects to CKAN formats before calling the API. ", _jsxs(_components.strong, { children: ["Thus, you can use ", _jsx(_components.em, { children: "Frictionless Formats" }), " by default with the client"] }), "."] }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsx(_components.p, { children: "[!tip]As CKAN moves to Frictionless to default this will gradually become unnecessary." }), "\n"] }), "\n", _jsxs(_components.h2, { id: "quick-start", children: [_jsx(_components.a, { className: "heading-link", href: "#quick-start", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Quick start"] }), "\n", _jsxs(_components.p, { children: ["Most of this guide has Python programming language in mind, including its ", _jsxs(_components.a, { href: "https://www.python.org/dev/peps/pep-0008/#descriptive-naming-styles", target: "_blank", rel: "noopener noreferrer", children: ["convention regading using ", _jsx(_components.em, { children: "snake case" }), " for instances and methods names"] }), "."] }), "\n", _jsxs(_components.p, { children: ["If needed, you can adapt the instructions to JavaScript and R (coming soon) by using ", _jsx(_components.em, { children: "camel case" }), " instead — for example, if in the Python code we have ", _jsx(_components.code, { className: "language-auto", children: "client.push_blob(…)" }), ", in JavaScript it would be ", _jsx(_components.code, { className: "language-auto", children: "client.pushBlob(…)" }), "."] }), "\n", _jsxs(_components.h3, { id: "prerequisites", children: [_jsx(_components.a, { className: "heading-link", href: "#prerequisites", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Prerequisites"] }), "\n", _jsx(_components.p, { children: "Install the client for your language of choice:" }), "\n", _jsxs(_components.ul, { children: ["\n", _jsxs(_components.li, { children: ["Python: ", _jsx(_components.a, { href: "https://github.com/datopian/ckan-client-py#install", target: "_blank", rel: "noopener noreferrer", children: "https://github.com/datopian/ckan-client-py#install" })] }), "\n", _jsxs(_components.li, { children: ["JavaScript: ", _jsx(_components.a, { href: "https://github.com/datopian/ckan-client-js#install", target: "_blank", rel: "noopener noreferrer", children: "https://github.com/datopian/ckan-client-js#install" })] }), "\n", _jsxs(_components.li, { children: ["R: ", _jsx(_components.em, { children: "coming soon" })] }), "\n"] }), "\n", _jsxs(_components.h3, { id: "create-a-client", children: [_jsx(_components.a, { className: "heading-link", href: "#create-a-client", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Create a client"] }), "\n", _jsxs(_components.h4, { id: "python", children: [_jsx(_components.a, { className: "heading-link", href: "#python", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Python"] }), "\n", _jsx(_components.pre, { className: "language-python", children: _jsxs(_components.code, { className: "language-python code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: [_jsx(_components.span, { className: "token keyword", children: "from" }), " ckanclient ", _jsx(_components.span, { className: "token keyword", children: "import" }), " Client\n"] }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsxs(_components.span, { className: "code-line", children: ["api_key ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'771a05ad-af90-4a70-beea-cbb050059e14'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["api_url ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'http://localhost:5000'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["organization ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'datopian'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["dataset ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'dailyprices'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["lfs_url ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'http://localhost:9419'" }), "\n"] }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsxs(_components.span, { className: "code-line", children: ["client ", _jsx(_components.span, { className: "token operator", children: "=" }), " Client", _jsx(_components.span, { className: "token punctuation", children: "(" }), "api_url", _jsx(_components.span, { className: "token punctuation", children: "," }), " organization", _jsx(_components.span, { className: "token punctuation", children: "," }), " dataset", _jsx(_components.span, { className: "token punctuation", children: "," }), " lfs_url", _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.h4, { id: "javascript", children: [_jsx(_components.a, { className: "heading-link", href: "#javascript", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "JavaScript"] }), "\n", _jsx(_components.pre, { className: "language-javascript", children: _jsxs(_components.code, { className: "language-javascript code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: [_jsx(_components.span, { className: "token keyword", children: "const" }), " ", _jsx(_components.span, { className: "token punctuation", children: "{" }), " ", _jsx(_components.span, { className: "token maybe-class-name", children: "Client" }), " ", _jsx(_components.span, { className: "token punctuation", children: "}" }), " ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token function", children: "require" }), _jsx(_components.span, { className: "token punctuation", children: "(" }), _jsx(_components.span, { className: "token string", children: "'ckanClient'" }), _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsxs(_components.span, { className: "code-line", children: ["apiKey ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'771a05ad-af90-4a70-beea-cbb050059e14'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["apiUrl ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'http://localhost:5000'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["organization ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'datopian'" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["dataset ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token string", children: "'dailyprices'" }), "\n"] }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsxs(_components.span, { className: "code-line", children: [_jsx(_components.span, { className: "token keyword", children: "const" }), " client ", _jsx(_components.span, { className: "token operator", children: "=" }), " ", _jsx(_components.span, { className: "token function", children: _jsx(_components.span, { className: "token maybe-class-name", children: "Client" }) }), _jsx(_components.span, { className: "token punctuation", children: "(" }), "apiKey", _jsx(_components.span, { className: "token punctuation", children: "," }), " organization", _jsx(_components.span, { className: "token punctuation", children: "," }), " dataset", _jsx(_components.span, { className: "token punctuation", children: "," }), " apiUrl", _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.h3, { id: "upload-a-resource", children: [_jsx(_components.a, { className: "heading-link", href: "#upload-a-resource", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Upload a resource"] }), "\n", _jsx(_components.p, { children: "That is to say, upload a file, implicitly creating a new dataset." }), "\n", _jsxs(_components.h4, { id: "python-1", children: [_jsx(_components.a, { className: "heading-link", href: "#python-1", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Python"] }), "\n", _jsx(_components.pre, { className: "language-python", children: _jsxs(_components.code, { className: "language-python code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: [_jsx(_components.span, { className: "token keyword", children: "from" }), " frictionless ", _jsx(_components.span, { className: "token keyword", children: "import" }), " describe\n"] }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsx(_components.span, { className: "code-line", children: "\n" }), _jsxs(_components.span, { className: "code-line", children: ["resource ", _jsx(_components.span, { className: "token operator", children: "=" }), " describe", _jsx(_components.span, { className: "token punctuation", children: "(" }), _jsx(_components.span, { className: "token string", children: "'my-data.csv'" }), _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "push_blob", _jsx(_components.span, { className: "token punctuation", children: "(" }), "resource", _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.h3, { id: "create-a-new-empty-dataset-with-metadata", children: [_jsx(_components.a, { className: "heading-link", href: "#create-a-new-empty-dataset-with-metadata", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Create a new empty Dataset with metadata"] }), "\n", _jsxs(_components.h4, { id: "python-2", children: [_jsx(_components.a, { className: "heading-link", href: "#python-2", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Python"] }), "\n", _jsx(_components.pre, { className: "language-python", children: _jsxs(_components.code, { className: "language-python code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "create", _jsx(_components.span, { className: "token punctuation", children: "(" }), _jsx(_components.span, { className: "token string", children: "'my-data'" }), _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "push", _jsx(_components.span, { className: "token punctuation", children: "(" }), "resource", _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.h3, { id: "adding-a-resource-to-an-existing-dataset", children: [_jsx(_components.a, { className: "heading-link", href: "#adding-a-resource-to-an-existing-dataset", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Adding a resource to an existing Dataset"] }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsx(_components.p, { children: "[!note]Not implemented yet." }), "\n"] }), "\n", _jsx(_components.pre, { className: "language-python", children: _jsxs(_components.code, { className: "language-python code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "create", _jsx(_components.span, { className: "token punctuation", children: "(" }), _jsx(_components.span, { className: "token string", children: "'my-data'" }), _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "push_resource", _jsx(_components.span, { className: "token punctuation", children: "(" }), "resource", _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.h3, { id: "edit-a-datasets-metadata", children: [_jsx(_components.a, { className: "heading-link", href: "#edit-a-datasets-metadata", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "Edit a Dataset's metadata"] }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsx(_components.p, { children: "[!note]Not implemented yet." }), "\n"] }), "\n", _jsx(_components.pre, { className: "language-python", children: _jsxs(_components.code, { className: "language-python code-highlight", children: [_jsxs(_components.span, { className: "code-line", children: ["dataset ", _jsx(_components.span, { className: "token operator", children: "=" }), " client", _jsx(_components.span, { className: "token punctuation", children: "." }), "retrieve", _jsx(_components.span, { className: "token punctuation", children: "(" }), _jsx(_components.span, { className: "token string", children: "'sample-dataset'" }), _jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: ["client", _jsx(_components.span, { className: "token punctuation", children: "." }), "update_metadata", _jsx(_components.span, { className: "token punctuation", children: "(" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: [" dataset", _jsx(_components.span, { className: "token punctuation", children: "," }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: [" metadata", _jsx(_components.span, { className: "token punctuation", children: ":" }), " ", _jsx(_components.span, { className: "token punctuation", children: "{" }), _jsx(_components.span, { className: "token string", children: "'maintainer_email'" }), _jsx(_components.span, { className: "token punctuation", children: ":" }), " ", _jsx(_components.span, { className: "token string", children: "'sample@datopian.com'" }), _jsx(_components.span, { className: "token punctuation", children: "}" }), "\n"] }), _jsxs(_components.span, { className: "code-line", children: [_jsx(_components.span, { className: "token punctuation", children: ")" }), "\n"] })] }) }), "\n", _jsxs(_components.p, { children: ["For details of metadata see the ", _jsx(_components.a, { href: "#metadata-reference", children: "metadata reference below" }), "."] }), "\n", _jsxs(_components.h2, { id: "api---porcelain", children: [_jsx(_components.a, { className: "heading-link", href: "#api---porcelain", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), "API - Porcelain"] }), "\n", _jsxs(_components.h3, { id: "clientcreate", children: [_jsx(_components.a, { className: "heading-link", href: "#clientcreate", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), _jsx(_components.code, { className: "language-auto", children: "Client.create" })] }), "\n", _jsxs(_components.p, { children: ["Expects as a single argument: a ", _jsx(_components.em, { children: "string" }), ", or a ", _jsx(_components.em, { children: "dict" }), " (in Python), or an ", _jsx(_components.em, { children: "object" }), " (in JavaScript). This argument is either a valid dataset name or dictionary with metadata for the dataset in Frictionless format."] }), "\n", _jsxs(_components.h3, { id: "clientpush", children: [_jsx(_components.a, { className: "heading-link", href: "#clientpush", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), _jsx(_components.code, { className: "language-auto", children: "Client.push" })] }), "\n", _jsxs(_components.p, { children: ["Expects a single argument: a ", _jsx(_components.em, { children: "dict" }), " (in Python) or an ", _jsx(_components.em, { children: "object" }), " (in JavaScript) with a dataset metadata in Frictionless format."] }), "\n", _jsxs(_components.h3, { id: "clientretrieve", children: [_jsx(_components.a, { className: "heading-link", href: "#clientretrieve", children: _jsx(_components.svg, { xmlns: "http:www.w3.org/2000/svg", fill: "#ab2b65", viewBox: "0 0 20 20", className: "w-5 h-5", children: _jsx(_components.path, { fillRule: "evenodd", clipRule: "evenodd", d: "M9.493 2.853a.75.75 0 00-1.486-.205L7.545 6H4.198a.75.75 0 000 1.5h3.14l-.69 5H3.302a.75.75 0 000 1.5h3.14l-.435 3.148a.75.75 0 001.486.205L7.955 14h2.986l-.434 3.148a.75.75 0 001.486.205L12.456 14h3.346a.75.75 0 000-1.5h-3.14l.69-5h3.346a.75.75 0 000-1.5h-3.14l.435-3.147a.75.75 0 00-1.486-.205L12.045 6H9.059l.434-3.147zM8.852 7.5l-.69 5h2.986l.69-5H8.852z" }) }) }), _jsx(_components.code, { className: "language-auto", children: "Client.retrieve" })] }), "\n", _jsxs(_components.p, { children: ["Expects a single argument: a string with a dataset name or uniquer ID. Returns a Frictionless resource as a ", _jsx(_components.em, { children: "dict" }), " (in Python) or as an ", _jsx(_components.em, { children: "Promisse .