Skip to content

data_types

array

                                                                                
 lineage              array                                                     
                      any                                                       
 qualifier profile(s) -- n/a --                                                 
 Documentation                                                                  
                        An array, in most cases used as a column within a       
                        table.                                                  
                                                                                
                        Internally, this type uses the                          
                        [KiaraArray][kiara_plugin.tabular.models.array.Kiara…   
                        wrapper class to manage array data. This wrapper        
                        class, in turn, uses an Apache Arrow Array to store     
                        the data in memory (and on disk).                       
                                                                                
 Author(s)                                                                      
                        Markus Binsteiner   markus@frkl.io                      
                                                                                
 Context                                                                        
                        Tags         tabular                                    
                        Labels       package: kiara_plugin.tabular              
                        References   source_repo:                               
                                     https://github.com/DHARPA-Project/kiara…   
                                     documentation:                             
                                     https://DHARPA-Project.github.io/kiara_…   
                                                                                
 Python class                                                                   
                        python_class_name    ArrayType                          
                        python_module_name   kiara_plugin.tabular.data_types…   
                        full_name            kiara_plugin.tabular.data_types…   
                                                                                
 Config class                                                                   
                        python_class_name    DataTypeConfig                     
                        python_module_name   kiara.data_types                   
                        full_name            kiara.data_types.DataTypeConfig    
                                                                                
 Value class                                                                    
                        python_class_name    KiaraArray                         
                        python_module_name   kiara_plugin.tabular.models.arr…   
                        full_name            kiara_plugin.tabular.models.arr…   
                                                                                
                                                                                

database

                                                                                
 lineage              database                                                  
                      any                                                       
 qualifier profile(s) -- n/a --                                                 
 Documentation                                                                  
                        A database, containing one or several tables.           
                                                                                
                        This is backed by the                                   
                        [KiaraDatabase][kiara_plugin.tabular.models.db.Kiara…   
                        class to manage the stored data.                        
                                                                                
 Author(s)                                                                      
                        Markus Binsteiner   markus@frkl.io                      
                                                                                
 Context                                                                        
                        Tags         tabular                                    
                        Labels       package: kiara_plugin.tabular              
                        References   source_repo:                               
                                     https://github.com/DHARPA-Project/kiara…   
                                     documentation:                             
                                     https://DHARPA-Project.github.io/kiara_…   
                                                                                
 Python class                                                                   
                        python_class_name    DatabaseType                       
                        python_module_name   kiara_plugin.tabular.data_types…   
                        full_name            kiara_plugin.tabular.data_types…   
                                                                                
 Config class                                                                   
                        python_class_name    DataTypeConfig                     
                        python_module_name   kiara.data_types                   
                        full_name            kiara.data_types.DataTypeConfig    
                                                                                
 Value class                                                                    
                        python_class_name    KiaraDatabase                      
                        python_module_name   kiara_plugin.tabular.models.db     
                        full_name            kiara_plugin.tabular.models.db.…   
                                                                                
                                                                                

table

                                                                                
 lineage              table                                                     
                      any                                                       
 qualifier profile(s) -- n/a --                                                 
 Documentation                                                                  
                        Tabular data (table, spreadsheet, data_frame, what      
                        have you).                                              
                                                                                
                        The table data is organized in sets of columns          
                        (arrays of data of the same type), with each column     
                        having a string identifier.                             
                                                                                
                        kiara uses an instance of the                           
                        [KiaraTable][kiara_plugin.tabular.models.table.Kiara…   
                        class to manage the table data, which let's             
                        developers access it in different formats (Apache       
                        Arrow Table, Pandas dataframe, Python dict of lists,    
                        more to follow...).                                     
                                                                                
                        Please consult the API doc of the KiaraTable class      
                        for more information about how to access and query      
                        the data:                                               
                                                                                
                        KiaraTable API doc                                   
                                                                                
                        Internally, the data is stored in Apache Feather        
                        format -- both in memory and on disk when saved,        
                        which enables some advanced usage to preserve memory    
                        and compute overhead.                                   
                                                                                
 Author(s)                                                                      
                        Markus Binsteiner   markus@frkl.io                      
                                                                                
 Context                                                                        
                        Tags         tabular                                    
                        Labels       package: kiara_plugin.tabular              
                        References   source_repo:                               
                                     https://github.com/DHARPA-Project/kiara…   
                                     documentation:                             
                                     https://DHARPA-Project.github.io/kiara_…   
                                                                                
 Python class                                                                   
                        python_class_name    TableType                          
                        python_module_name   kiara_plugin.tabular.data_types…   
                        full_name            kiara_plugin.tabular.data_types…   
                                                                                
 Config class                                                                   
                        python_class_name    DataTypeConfig                     
                        python_module_name   kiara.data_types                   
                        full_name            kiara.data_types.DataTypeConfig    
                                                                                
 Value class                                                                    
                        python_class_name    KiaraTable                         
                        python_module_name   kiara_plugin.tabular.models.tab…   
                        full_name            kiara_plugin.tabular.models.tab…   
                                                                                
                                                                                

tables

                                                                                
 lineage              tables                                                    
                      any                                                       
 qualifier profile(s) -- n/a --                                                 
 Documentation                                                                  
                        Multiple tabular data sets.                             
                                                                                
                        The data is organized in sets of tables (which are      
                        sets of columns), each table having a string            
                        identifier.                                             
                                                                                
                        This is similar to the 'database' data type, the main   
                        difference being that 'database' is backed by sqlite,   
                        whereas 'tables' is backed by Apache Feather/Arrow.     
                        There is no hard rule when it's better to use which,    
                        but in general, if you need to access the datasets on   
                        a row-basis, 'database' is the better fit, for more     
                        column-based analytical queries, 'tables' is better.    
                                                                                
 Author(s)                                                                      
                        Markus Binsteiner   markus@frkl.io                      
                                                                                
 Context                                                                        
                        Tags         tabular                                    
                        Labels       package: kiara_plugin.tabular              
                        References   source_repo:                               
                                     https://github.com/DHARPA-Project/kiara…   
                                     documentation:                             
                                     https://DHARPA-Project.github.io/kiara_…   
                                                                                
 Python class                                                                   
                        python_class_name    TablesType                         
                        python_module_name   kiara_plugin.tabular.data_types…   
                        full_name            kiara_plugin.tabular.data_types…   
                                                                                
 Config class                                                                   
                        python_class_name    DataTypeConfig                     
                        python_module_name   kiara.data_types                   
                        full_name            kiara.data_types.DataTypeConfig    
                                                                                
 Value class                                                                    
                        python_class_name    KiaraTables                        
                        python_module_name   kiara_plugin.tabular.models.tab…   
                        full_name            kiara_plugin.tabular.models.tab…