Options
All
  • Public
  • Public/Protected
  • All
Menu

Overview

An interface for managing a Fluvio cluster

Most applications will not require administrator functionality. The FluvioAdmin interface is used to create, edit, and manage Topics and other operational items. Think of the difference between regular clients of a Database and its administrators. Regular clients may be applications which are reading and writing data to and from tables that exist in the database. Database administrators would be the ones actually creating, editing, or deleting tables. The same thing goes for Fluvio administrators.

If you are writing an application whose purpose is to manage a Fluvio cluster for you, you can gain access to the FluvioAdmin client via the regular Fluvio client

Example Construction

const fluvio = new Fluvio({ host, port })

await fluvio.connect();

const admin = await fluvio.admin();

Errors

Creating an admin client will fail if you do not have admin authorization in the connected custer.

Hierarchy

  • FluvioAdmin

Index

Constructors

constructor

  • This method is not intended to be used directly. This is a helper method used by the Fluvio class to pass in a native object, along with top-level Fluvio client options, if any.

    Parameters

    • inner: FluvioAdmin

      The native FluvioAdmin module, must be the value returned from await new Fluvio().admin();

    • Optional options: Partial<Options>

      Optional values inherited from top-level options;

    Returns FluvioAdmin

Properties

Private inner

Optional options

options: undefined | Partial<Options>

Methods

createCustomSpu

  • createCustomSpu(name: string, spec?: CustomSpuSpec): Promise<void>
  • createCustomSpu(name: string, spec?: CustomSpuSpec): Promise<void>
  • Parameters

    Returns Promise<void>

  • Create a new custom Streaming Processing Unit (SPU)

    Parameters

    • name: string

      Name of the custom spu;

    • Optional spec: CustomSpuSpec

      Pass in a custom spec or use a default based on top-level options;

    Returns Promise<void>

createManagedSpu

  • createManagedSpu(name: string, spec?: SpuGroupSpec): Promise<void>
  • createManagedSpu(name: string, spec?: SpuGroupSpec): Promise<void>
  • Parameters

    Returns Promise<void>

  • Create a new managed Streaming Processing Unit (SPU)

    Parameters

    • name: string

      name of the managed spu group

    • Optional spec: SpuGroupSpec

      Optional specification for the SpuGroup. If no spec is provided, default settings will be used.

    Returns Promise<void>

createTopic

deleteCustomSpu

  • deleteCustomSpu(key: string | number): Promise<void>
  • deleteCustomSpu(key: string | number): Promise<void>
  • Parameters

    • key: string | number

    Returns Promise<void>

  • Delete a custom SPU using either a string or number;

    Parameters

    • key: string | number

      SPU key to target for deletion;

    Returns Promise<void>

deleteManagedSpu

  • deleteManagedSpu(name: string): Promise<void>
  • deleteManagedSpu(name: string): Promise<void>
  • Parameters

    • name: string

    Returns Promise<void>

  • Delete a managed SPU by name

    Parameters

    • name: string

      Name of the managed SPU to delete;

    Returns Promise<void>

deleteTopic

  • deleteTopic(topic: string): Promise<string>
  • deleteTopic(topic: string): Promise<string>
  • Parameters

    • topic: string

    Returns Promise<string>

  • Delete a topic by name

    Parameters

    • topic: string

      Name of the topic to delete

    Returns Promise<string>

findPartition

findTopic

  • findTopic(topic: string): Promise<Topic>
  • findTopic(topic: string): Promise<Topic>
  • Parameters

    • topic: string

    Returns Promise<Topic>

  • Find a topic by name

    Parameters

    • topic: string

      Name of the topic to find;

    Returns Promise<Topic>

listPartitions

  • listPartitions(): Promise<string>
  • listPartitions(): Promise<string>

listSpu

  • listSpu(): Promise<string>
  • listSpu(): Promise<string>
  • Returns Promise<string>

  • List SPUs TODO: convert stringified json to structured types;

    Returns Promise<string>

listTopic

  • listTopic(): Promise<string>
  • listTopic(): Promise<string>

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Private property
  • Private method
  • Static method

Generated using TypeDoc