py1010

The 1010data Python SDK enables developers to create applications that connect their applications to the 1010data Insights Platform for processing and retrieval of big data.

This guide contains the information you need to start developing a new application if this is your first time working with the SDK. The Python SDK enables the development of both single-threaded and multi-threaded applications, working with either single-user Insights Platform sessions or SAM pools.

See Example projects for longer examples and py1010 reference for a complete reference to py1010.

Note

Unless otherwise indicated, the examples in this guide are written for Python 3.

Contents

• Installing py1010
  • Requirements
  • Installation
  • Using the single sign-on (SSO) feature
• Basic usage
  • Setting up an application
  • Establishing a session
    • Login types
    • Optional Parameters
      • group
      • retry
      • wait
      • logFile
      • authentication
      • **kwarg
        • timeout(connectTimeout, timeout)
        • reuseConnection
        • lenient
        • ignoreSSLErrors
    • Connecting via proxy
      • Examples
  • Running a query
  • Accessing query results
  • Cleaning up a session
  • Uploading from FTP
  • Uploading a parquet file
    • Uploading a local file
    • Uploading from FTP
    • Uploading from Amazon S3
    • Uploading from ABS
    • Adding a key for S3 or ABS
  • Exception handling
  • Converting results to a pandas DataFrame
    • Example
• Shared Access Management pools
  • flushpool (Flush a SAM pool)
  • resetpool (Reset a SAM pool)
  • warmpool (Warm a SAM pool)
• Best practices
• Example projects
  • columnprinter.py
  • dictslice.py
  • rowprinter.py
  • server.py
  • simplethread.py
• py1010 reference
  • py1010: 1010data Insights Platform’s Python SDK
    • Data Conversion
      • Integer Columns
      • Float Columns
      • String Columns
      • Conversion Functions
  • DBMError
  • TentenClosedSessionException
  • TentenException
  • TentenNotLastException
  • TentenNotRunException
  • TentenPoolFullException
  • TentenTransactionException
  • AWSKey
  • AddtableStatus
    • AddtableStatus.Status
    • AddtableStatus.expectedBytes
    • AddtableStatus.filteredBytes
    • AddtableStatus.message
    • AddtableStatus.skippedBytes
    • AddtableStatus.status
    • AddtableStatus.tablepath
    • AddtableStatus.targets
    • AddtableStatus.totalBytes
    • AddtableStatus.totalRecs
  • BaseQuery
  • CloudKey
    • CloudKey.id
    • CloudKey.key
    • CloudKey.keytype
    • CloudKey.name
    • CloudKey.region
  • Column
    • Column.defaultAConv()
    • Column.defaultFConv()
    • Column.defaultIConv()
    • Column.defaultJConv()
    • Column.fetchrows()
    • Column.format_value()
    • Column.get()
    • Column.getaConv()
    • Column.getfConv()
    • Column.getiConv()
    • Column.getjConv()
    • Column.getlocal()
    • Column.has()
    • Column.dec
    • Column.format
    • Column.format_type
    • Column.ktype
    • Column.name
    • Column.nrows
    • Column.rawValues
    • Column.title
    • Column.type
    • Column.width
    • Column.win_size
  • ColumnInfo
    • ColumnInfo.Fix
    • ColumnInfo.Index
    • ColumnInfo.fromSourceCol()
    • ColumnInfo.init()
    • ColumnInfo.desc
    • ColumnInfo.format
    • ColumnInfo.name
    • ColumnInfo.title
    • ColumnInfo.type
  • DBMDo
    • DBMDo.combine_tabs()
    • DBMDo.list_tabs()
  • DirEntry
    • DirEntry.asdict()
    • DirEntry.metaInfo()
    • DirEntry.setMetaInfo()
    • DirEntry.id
    • DirEntry.ldesc
    • DirEntry.name
    • DirEntry.owner
    • DirEntry.sdesc
    • DirEntry.title
    • DirEntry.type
    • DirEntry.update
  • Directory
    • Directory.children()
    • Directory.createDirectory()
    • Directory.fromPath()
    • Directory.parents()
    • Directory.removeDirectory()
  • Holder
    • Holder.PTR
  • MetaData
    • MetaData.asdict()
    • MetaData.fromPath()
    • MetaData.bytes
    • MetaData.id
    • MetaData.ldesc
    • MetaData.link
    • MetaData.maxdown
    • MetaData.owner
    • MetaData.path
    • MetaData.rows
    • MetaData.sdesc
    • MetaData.segs
    • MetaData.title
    • MetaData.type
    • MetaData.update
    • MetaData.users
  • OktaLogin
    • OktaLogin.getSession()
    • OktaLogin.sessionLogin()
  • Query
    • Query.colbyname()
    • Query.dictslice()
    • Query.expand()
    • Query.formatted_row()
    • Query.freshen()
    • Query.getrow()
    • Query.has()
    • Query.resave()
    • Query.rowasdict()
    • Query.rowiterator()
    • Query.run()
    • Query.save()
    • Query.saveFile()
    • Query.saveTableMaterialize()
    • Query.saveToFTP()
    • Query.cursor
    • Query.ldesc
    • Query.messagetext
    • Query.modelcols
    • Query.nrows
    • Query.rawValues
    • Query.rows
    • Query.sdesc
    • Query.title
    • Query.transfermode
    • Query.win_end
    • Query.win_size
    • Query.win_start
  • RowIterator
    • RowIterator.convertindex()
    • RowIterator.fetchrows()
    • RowIterator.getrow()
    • RowIterator.has()
  • Session
    • Session.addKey()
    • Session.addTable()
    • Session.addTableEnd()
    • Session.addTableFeed()
    • Session.addTableSpecs()
    • Session.addTableStatus()
    • Session.addTableStatusList()
    • Session.api2()
    • Session.authenticateCredentials()
    • Session.autoSpec()
    • Session.autoSpecFile()
    • Session.clearCache()
    • Session.close()
    • Session.createDirectory()
    • Session.dbm()
    • Session.debugAccum()
    • Session.delKey()
    • Session.directory()
    • Session.disableLog()
    • Session.dropTable()
    • Session.enableLog()
    • Session.getQueryOps()
    • Session.getRetry()
    • Session.getUID()
    • Session.logRawXML()
    • Session.memUsage()
    • Session.mergeTablesMaterialize()
    • Session.moveTable()
    • Session.peekOnce()
    • Session.ptr()
    • Session.putKey()
    • Session.query()
    • Session.readKeys()
    • Session.releaseUID()
    • Session.relog()
    • Session.saveTableMaterialize()
    • Session.searchTables()
    • Session.setRetry()
    • Session.setUserAgent()
    • Session.setXFF()
    • Session.stop()
    • Session.updateObject()
    • Session.uploadToFTP()
    • Session.uploadXMLTable()
    • Session.warmPool()
    • Session.APIversion
    • Session.epw
    • Session.ignoreSSLErrors
    • Session.lastResponse
    • Session.messagetext
    • Session.pswd
    • Session.rc
    • Session.realurl
    • Session.reuseConnection
    • Session.sessionid
    • Session.sid
    • Session.systemVersion
    • Session.timeout
    • Session.transactions
    • Session.url
    • Session.userAgent
    • Session.username
  • SourceColumnInfo
    • SourceColumnInfo.Alpha
    • SourceColumnInfo.Skip
    • SourceColumnInfo.Write
    • SourceColumnInfo.alpha
    • SourceColumnInfo.exp
    • SourceColumnInfo.format
    • SourceColumnInfo.name
    • SourceColumnInfo.nowrite
    • SourceColumnInfo.order
    • SourceColumnInfo.scale
    • SourceColumnInfo.skip
    • SourceColumnInfo.title
    • SourceColumnInfo.type
    • SourceColumnInfo.width
  • SourceFile
    • SourceFile.init()
    • SourceFile.account
    • SourceFile.bucket
    • SourceFile.container
    • SourceFile.keyname
    • SourceFile.path
    • SourceFile.range
    • SourceFile.sheetID
  • SourceInfo
    • SourceInfo.Arch
    • SourceInfo.AutoCorrectType
    • SourceInfo.RecType
    • SourceInfo.SrcType
    • SourceInfo.getWorksheets()
    • SourceInfo.init()
    • SourceInfo.arch
    • SourceInfo.autoCorrect
    • SourceInfo.begbytes
    • SourceInfo.begrecs
    • SourceInfo.eor
    • SourceInfo.files
    • SourceInfo.filter_target
    • SourceInfo.fix_mask
    • SourceInfo.format
    • SourceInfo.ignoreNull
    • SourceInfo.maskw
    • SourceInfo.mchr
    • SourceInfo.numCols
    • SourceInfo.numFiles
    • SourceInfo.numrecs
    • SourceInfo.pad
    • SourceInfo.rectype
    • SourceInfo.sep
    • SourceInfo.sourceType
    • SourceInfo.truncate
  • SourceSpec
    • SourceSpec.toXML()
  • TableInfo
    • TableInfo.Mode
    • TableInfo.Perm
    • TableInfo.SegType
    • TableInfo.TimeSeries
    • TableInfo.init()
    • TableInfo.access
    • TableInfo.chart
    • TableInfo.favorite
    • TableInfo.id
    • TableInfo.ldesc
    • TableInfo.link
    • TableInfo.materialize
    • TableInfo.maxdown
    • TableInfo.merge
    • TableInfo.method
    • TableInfo.mode
    • TableInfo.name
    • TableInfo.numBytes
    • TableInfo.numCols
    • TableInfo.numRows
    • TableInfo.own
    • TableInfo.owner
    • TableInfo.report
    • TableInfo.responsible
    • TableInfo.sdesc
    • TableInfo.secure
    • TableInfo.segmentation
    • TableInfo.segs
    • TableInfo.segsize
    • TableInfo.segtype
    • TableInfo.sort
    • TableInfo.stripe
    • TableInfo.stripe_factor
    • TableInfo.timeSeries
    • TableInfo.title
    • TableInfo.type
    • TableInfo.update
    • TableInfo.users
  • TableSpec
    • TableSpec.toXML()
  • by()
  • flushpool()
  • resetpool()
  • sampoolstatus()
  • st()
  • startLogging()
  • stopLogging()
  • warmpool()
• Troubleshooting and support
  • Submit a support request
• Changelog