Index

A

AsyncActionLogging — Class in namespace Keboola\Component\Logger

B

BaseComponent — Class in namespace Keboola\Component
This is the core class that does all the heavy lifting. By default you don't need to setup anything. There are some extension points for you to use if you want to customise the behavior.
BaseConfig — Class in namespace Keboola\Component\Config
Offers basic abstraction over the JSON config. You can extend it and add your own getters for custom parameters.
BaseConfigDefinition — Class in namespace Keboola\Component\Config
ConfigDefinition specifies the bare minimum of what should a config contain.
BaseComponentException — Class in namespace Keboola\Component\Exception

C

$BaseConfig#config — Property in class BaseConfig
ConfigInterface — Class in namespace Keboola\Component\Config

D

JsonHelper::decode() — Method in class JsonHelper

E

BaseComponent::execute() — Method in class BaseComponent
JsonHelper::encode() — Method in class JsonHelper

G

BaseComponent::getRawConfig() — Method in class BaseComponent
BaseComponent::getConfigDefinitionClass() — Method in class BaseComponent
Override this method if you have custom config definition class. This allows you to validate and require config parameters and fail fast if there is a missing parameter.
BaseComponent::getDataDir() — Method in class BaseComponent
BaseComponent::getConfig() — Method in class BaseComponent
BaseComponent::getManifestManager() — Method in class BaseComponent
BaseComponent::getLogger() — Method in class BaseComponent
BaseComponent::getInputState() — Method in class BaseComponent
BaseComponent::getConfigClass() — Method in class BaseComponent
Class of created config. It's useful if you want to implment getters for parameters in your config. It's prefferable to accessing configuration keys as arrays.
BaseComponent::getSyncActions() — Method in class BaseComponent
Whitelist method names that can be used as synchronous actions. This is a safeguard against executing any method of the component.
BaseConfig::getData() — Method in class BaseConfig
Returns all the data in config as associative array
BaseConfig::getValue() — Method in class BaseConfig
Returns value by key. You can supply default value for when the key is missing.
BaseConfig::getParameters() — Method in class BaseConfig
Returns parameters section of the config
BaseConfig::getStorage() — Method in class BaseConfig
Returns storage section of the config
BaseConfig::getImageParameters() — Method in class BaseConfig
Returns image_parameters section of the config
BaseConfig::getAuthorization() — Method in class BaseConfig
Returns authorization section of the config
BaseConfig::getAction() — Method in class BaseConfig
Returns action section of the config
BaseConfig::getInputFiles() — Method in class BaseConfig
BaseConfig::getExpectedOutputFiles() — Method in class BaseConfig
BaseConfig::getInputTables() — Method in class BaseConfig
BaseConfig::getExpectedOutputTables() — Method in class BaseConfig
BaseConfig::getOAuthApiData() — Method in class BaseConfig
BaseConfig::getOAuthApiAppSecret() — Method in class BaseConfig
BaseConfig::getOAuthApiAppKey() — Method in class BaseConfig
BaseConfigDefinition::getConfigTreeBuilder() — Method in class BaseConfigDefinition
Generates the configuration tree builder. You probably don't need to touch this.
BaseConfigDefinition::getParametersDefinition() — Method in class BaseConfigDefinition
Definition of parameters section. Override in extending class to validate parameters sent to the component early.
BaseConfigDefinition::getRootDefinition() — Method in class BaseConfigDefinition
Root definition to be overridden in special cases
ConfigInterface::getData() — Method in class ConfigInterface
ConfigInterface::getValue() — Method in class ConfigInterface
Logger::getDefaultErrorHandler() — Method in class Logger
Logger::getDefaultLogHandler() — Method in class Logger
Logger::getDefaultCriticalHandler() — Method in class Logger
Logger::getSyncActionErrorHandler() — Method in class Logger
ManifestManager::getManifestFilename() — Method in class ManifestManager
ManifestManager::getFileManifest() — Method in class ManifestManager
ManifestManager::getTableManifest() — Method in class ManifestManager

I

BaseComponent::initializeSyncActions() — Method in class BaseComponent
BaseComponent::isSyncAction() — Method in class BaseComponent
BaseComponentException::invalidSyncAction() — Method in class BaseComponentException

J

JsonHelper — Class in namespace Keboola\Component
JsonHelperException — Class in namespace Keboola\Component\JsonHelper

L

BaseComponent::loadConfig() — Method in class BaseComponent
Automatically loads configuration from datadir, instantiates specified config class and validates it with specified confing definition class
BaseComponent::loadInputState() — Method in class BaseComponent
BaseComponent::loadManifestManager() — Method in class BaseComponent
Loads manifest manager with application's datadir
Logger — Class in namespace Keboola\Component

M

ManifestManager — Class in namespace Keboola\Component\Manifest
Handles everything related to generating and reading manifests for tables and files.

O

OptionsValidationException — Class in namespace Keboola\Component\Manifest\ManifestManager\Options
OutFileManifestOptions — Class in namespace Keboola\Component\Manifest\ManifestManager\Options
OutTableManifestOptions — Class in namespace Keboola\Component\Manifest\ManifestManager\Options

R

BaseComponent::run() — Method in class BaseComponent
This is the main method for your code to run in. You have the Config and ManifestManager ready as well as environment set up.
BaseComponentException::runCannotBeSyncAction() — Method in class BaseComponentException
BaseComponentException::runMethodCannotBePublic() — Method in class BaseComponentException
JsonHelper::readFile() — Method in class JsonHelper

S

BaseComponent::setEnvironment() — Method in class BaseComponent
Prepares environment. Sets error reporting for the app to fail on any error, warning or notice. If your code emits notices and cannot be fixed, you can set error_reporting in $application->run() method.
BaseComponent::setConfig() — Method in class BaseComponent
BaseComponent::setDataDir() — Method in class BaseComponent
Data dir is set without the trailing slash
Logger::setupSyncActionLogging() — Method in class Logger
Sync actions MUST NOT output anything to stdout
Logger::setupAsyncActionLogging() — Method in class Logger
AsyncActionLogging::setupAsyncActionLogging() — Method in class AsyncActionLogging
SyncActionLogging — Class in namespace Keboola\Component\Logger
SyncActionLogging::setupSyncActionLogging() — Method in class SyncActionLogging
Sync actions MUST NOT output anything to stdout
OutFileManifestOptions::setTags() — Method in class OutFileManifestOptions
OutFileManifestOptions::setIsPublic() — Method in class OutFileManifestOptions
OutFileManifestOptions::setIsPermanent() — Method in class OutFileManifestOptions
OutFileManifestOptions::setNotify() — Method in class OutFileManifestOptions
OutFileManifestOptions::setIsEncrypted() — Method in class OutFileManifestOptions
OutTableManifestOptions::setDestination() — Method in class OutTableManifestOptions
OutTableManifestOptions::setPrimaryKeyColumns() — Method in class OutTableManifestOptions
OutTableManifestOptions::setColumns() — Method in class OutTableManifestOptions
OutTableManifestOptions::setIncremental() — Method in class OutTableManifestOptions
OutTableManifestOptions::setMetadata() — Method in class OutTableManifestOptions
OutTableManifestOptions::setColumnMetadata() — Method in class OutTableManifestOptions
OutTableManifestOptions::setDelimiter() — Method in class OutTableManifestOptions
OutTableManifestOptions::setEnclosure() — Method in class OutTableManifestOptions

T

OutFileManifestOptions::toArray() — Method in class OutFileManifestOptions
OutTableManifestOptions::toArray() — Method in class OutTableManifestOptions

U

UserException — Class in namespace Keboola\Component
Throw this exception whenever an expectation fails and user is able to fix it by supplying different configuration or data. Typical case is invalid parameter in config. Do not use it for any expectation failure, that is out of user's reach. Such case would be when there are insufficient privledges to write a file.

W

BaseComponent::writeOutputStateToFile() — Method in class BaseComponent
JsonHelper::writeFile() — Method in class JsonHelper
ManifestManager::writeFileManifest() — Method in class ManifestManager
ManifestManager::writeTableManifest() — Method in class ManifestManager

_

BaseComponent::__construct() — Method in class BaseComponent
BaseConfig::__construct() — Method in class BaseConfig
Logger::__construct() — Method in class Logger
ManifestManager::__construct() — Method in class ManifestManager