Skip to content

Clarify usage of TypeScript sdk #389

@Vahor

Description

@Vahor

👋

README has a section "Quick Start User Guide" where it seems to explain that we have to clone / build the cdk then link it ourselves to use it.
Seems a bit complex, and not very "quick start" when there's a npm package.

And on the other hand, on databricks doc, it says that the simplest way is to use npm install @databricks/zerobus-ingest-sdk.
The issue here is that the published package has utils/descriptor.ts, a .ts file that can't be imported as is, but needed to use loadDescriptorProto.
(Note that the published package also has unnecessary files: schemas/ folder, src/, .. some might be needed for napi-rs build?)

npm install @databricks/zerobus-ingest-sdk
node -e "console.log(require('@databricks/zerobus-ingest-sdk/utils/descriptor'))"

(or used as an import)

gives

node:internal/modules/cjs/loader:1215
  throw err;
  ^

Error: Cannot find module '@databricks/zerobus-ingest-sdk/utils/descriptor'

with all that, i'm a bit confused on how to use the typescript sdk

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions