Reference

info

Parameter names are slightly different between JavaScript and Python. Python names require snake_case but are documented with camelCase.

Functions

boardList()Object

Retrieves all available boards.

boardRegister(board, name, cache, versions)String

Registers a board, useful to find resources with pinFind() or pin to additional boards with pin().

pinGet(name, board, cache, extract, version, files, signature)Object

Retrieves a pin by name and, by default, from the local board. You can use the board parameter to specify which board to retrieve a pin from. If a board is not specified, it will use pinFind() to find the pin across all boards and retrieve the one that matches by name.

pinRemove(name, board)

Removes a pin by name from the local or given board.

pinFind(text, board, name, extended)

Find a pin in any board registered.

boardList() ⇒ Object

Retrieves all available boards.

Kind: global function
Returns: Object - All the names from the registered boards.
Example

pins.boardList();

boardRegister(board, name, cache, versions) ⇒ String

Registers a board, useful to find resources with pinFind() or pin to additional boards with pin().

Kind: global function
Returns: String - The name of the board.

ParamTypeDescription
boardStringThe name of the board to register.
nameStringAn optional name to identify this board, defaults to the board name.
cacheStringThe local folder to use as a cache.
versionsBooleanShould this board be registered with support for versions?

Example

pins.boardRegister("s3", {
bucket: "bucket",
key: "key",
secret: "secret"
});

pinGet(name, board, cache, extract, version, files, signature) ⇒ Object

Retrieves a pin by name and, by default, from the local board. You can use the board parameter to specify which board to retrieve a pin from. If a board is not specified, it will use pinFind() to find the pin across all boards and retrieve the one that matches by name.

Kind: global function
Returns: Object - A pin from a given board.

ParamTypeDescription
nameStringThe name of the pin.
boardStringThe board where this pin will be retrieved from.
cacheBooleanShould the pin cache be used? Defaults to true.
extractBooleanShould compressed files be extracted? Each board defines the default behavior.
versionStringThe version of the dataset to retrieve, defaults to latest one.
filesBooleanShould only the file names be returned? Defaults to false.
signatureStringOptional signature to validate this pin, use pin_info() to compute signature.

Example

pins.pinGet("numbers")

pinRemove(name, board)

Removes a pin by name from the local or given board.

Kind: global function

ParamTypeDescription
nameStringThe name of the pin.
boardObjectThe board where this pin will be retrieved from.

Example

pins.pinRemove("numbers", { board: 'local' })

pinFind(text, board, name, extended)

Find a pin in any board registered.

Kind: global function

ParamTypeDescription
textStringThe text to find in the pin description or name.
boardStringThe board where this pin will be retrieved from.
nameStringThe exact name of the pin to match when searching.
extendedBooleanShould additional board-specific columns be shown?

Example

pins.pinFind("")