Download the PHP package sminnee/stitchdata-php without Composer
On this page you can find all versions of the php package sminnee/stitchdata-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sminnee/stitchdata-php
More information about sminnee/stitchdata-php
Files in sminnee/stitchdata-php
Package stitchdata-php
Short Description PHP SDK for StitchData.com's Import API
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package stitchdata-php
stitchdata-php
PHP SDK for StitchData.com's Import API.
Installation
This is a Composer library, and can be installed with composer require. The current release is ^0.1
Usage
new StitchApi(string $clientId, string $accessToken)
The Sminnee\StitchData\StitchApi class provides access to the API. Its constructor takes 2 arguments, which are described in the Import API documentation.
StitchApi::validate(array $data = null, $includeClientId = true)
Validates that the connection is working and that your credentials are correct.
- Validates the content (
$data) of a request. It must be an array of maps. - If
$datais omitted, a dummy request will be provided, including the client ID - If
$includeClientIdis true, then aclient_idproperty will be added to every record in data, unless it is already specified.
StitchApi::pushRecords(string $tableName, array $keyNames, iterable $records, int $batchSize = 100, ?callable $onBatchSent = null)
Pushes a number of records to the API in 1 or more batches.
$tableNameis the name of the table in your data warehouse that you wnat StitchData to create and/or write to. It will populatetable_namein requests to the API.$keyNamesis an array of record keys that you want to collectively use are your primary key. It will populatekey_namesin requests to the API.$recordsis an array or iterator of records, where each record is a map. This is the data to upsert.$batchSize, which defaults to 100, is the maximum number of records ot include in a single API request.$onBatchSent, a callback that will be called, passing an array of all sent records, once per successful API call. This can be especially helpful when passing a generator for the data, as you can make subsequent use of the data without separately iterating on it.
The Data types you can use are determined by the Transit library's default type mapping. Notably, you should use Datetime objects to represents dates/times.
StitchApi::apiCall($subUrl, $data, $includeClientId = true)
Raw call to the StitchData REST API. Where possible we recommend that you use the above methods, but this allows for accessing new API behaviour not yet supported the SDK.
Sequence generation
Sequence IDs are an important part of interacting with the API. pushRecords() automatically generates sequence IDs by the following mechanism.
- The first request will use a sequence ID of
time() * 1000. - Subquent requests will use the greater of sequence ID + 1 or time() * 1000.
If you wish to manually generate your own sequnce IDs you have to use the apiCall method instead, but please raise a github issue describing your use-case!
