Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 73 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,78 +17,104 @@ python3 -m pip install python-tabular

In your python environment, import pytabular and call the main Tabular Class. Only parameter needed is a solid connection string.
```python
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
```

You can query your models with the Query method from your tabular class. For Dax Queries, it will need the full Dax syntax. See [EVALUATE example](https://dax.guide/st/evaluate/). This will return a [Pandas DataFrame](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html). If you are looking to return a single value, see below. Simply wrap your query in the the curly brackets. The method will take that single cell table and just return the individual value. You can also query your DMV. See below for example. See [PyTabular Docs for Query](https://curts0.github.io/PyTabular/Tabular/#query).
```python
#Run basic queries
DAX_QUERY = "EVALUATE TOPN(100, 'Table1')"
model.Query(DAX_QUERY) #returns pd.DataFrame()
#Run basic queries
DAX_QUERY = "EVALUATE TOPN(100, 'Table1')"
model.Query(DAX_QUERY) #returns pd.DataFrame()

#or...
DMV_QUERY = "select * from $SYSTEM.DISCOVER_TRACE_EVENT_CATEGORIES"
model.Query(DMV_QUERY) #returns pd.DataFrame()
#or...
DMV_QUERY = "select * from $SYSTEM.DISCOVER_TRACE_EVENT_CATEGORIES"
model.Query(DMV_QUERY) #returns pd.DataFrame()

#or...
SINGLE_VALUE_QUERY_EX = "EVALUATE {1}"
model.Query(SINGLE_VALUE_QUERY_EX) #returns 1
#or...
SINGLE_VALUE_QUERY_EX = "EVALUATE {1}"
model.Query(SINGLE_VALUE_QUERY_EX) #returns 1
```

Refresh method to handle refreshes on your model. This is synchronous. Should be flexible enough to handle a variety of inputs. See [PyTabular Docs for Refreshing Tables and Partitions](https://curts0.github.io/PyTabular/Tabular/#refresh). Most basic way to refresh is input the table name string. The method will search for table and output exeption if unable to find it. For partitions you will need a key, value combination. Example, {'Table1':'Partition1'}. You can also take the key value pair and iterate through a group of partitions. Example, {'Table1':['Partition1','Partition2']}. Rather than providing a string, you can also input the actual class. See below for those examples, and you can acess them from the built in attributes self.Tables, self.Partitions or explore through the .Net classes yourself in self.Model.Tables.
```python
#You have a few options when refreshing.
model.Refresh('Table Name')
#You have a few options when refreshing.
model.Refresh('Table Name')

#or...
model.Refresh(['Table1','Table2','Table3'])
#or...
model.Refresh(['Table1','Table2','Table3'])

#or...
model.Refresh(<Table Class>)
#or...
model.Refresh(<Table Class>)

#or...
model.Refresh(<Partition Class>)
#or...
model.Refresh(<Partition Class>)

#or...
model.Refresh({'Table Name':'Partition Name'})
#or...
model.Refresh({'Table Name':'Partition Name'})

#or any kind of weird combination like
model.Refresh([{<Table Class>:<Partition Class>,'Table Name':['Partition1','Partition2']},'Table Name','Table Name2'])
#or any kind of weird combination like
model.Refresh([{<Table Class>:<Partition Class>,'Table Name':['Partition1','Partition2']},'Table Name','Table Name2'])

#Add Tracing=True for simple Traces tracking the refresh.
model.Refresh(['Table1','Table2'], Tracing=True)
#Add Tracing=True for simple Traces tracking the refresh.
model.Refresh(['Table1','Table2'], Tracing=True)
```

### Use Cases

##### If blank table, then refresh table.
This will use the function [Return_Zero_Row_Tables](https://curts0.github.io/PyTabular/Examples/#return_zero_row_tables) and the method [Refresh](https://curts0.github.io/PyTabular/Tabular/#refresh) from the Tabular class.
```python
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
tables = pytabular.Return_Zero_Row_Tables()
if len(tables) > 0:
model.Refresh(tables, Tracing = True) #Add a trace in there for some fun.
```

Built In Dax Query Helpers. In-case you want to run some quick queries similar to what vertipaq analyzer will do when getting row counts.
##### Sneak in a refresh.
This will use the method [Is_Process](https://curts0.github.io/PyTabular/Tabular/#is_process) and the method [Refresh](https://curts0.github.io/PyTabular/Tabular/#refresh) from the Tabular class. It will check the DMV to see if any jobs are currently running classified as processing.
```python
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
if model.Is_Process():
#do what you want if there is a refresh happening
else:
model.Refresh(TABLES_OR_PARTITIONS_TO_REFRESH)
```

#Query Every Column
model.Query_Every_Column() #Will return pd.DataFrame()

#Query Every Table
model.Query_Every_Table() #Will return pd.DataFrame()

'''
NOTE the default values for the query_function argument.
Query_Every_Column will get COUNTROWS(VALUES(_))
and Query_Every_Table() will get COUNTROWS(_)
with '_' being replaced with the dax identifier to the table or column in question.
You can replace this str with anything you want. For example output the MIN(_) or MAX(_) of each column rather than the default queries.
'''
##### Show refresh times in model.
This will use the function [Table_Last_Refresh_Times](https://curts0.github.io/PyTabular/Examples/#table_last_refresh_times) and the method [Create_Table](https://curts0.github.io/PyTabular/Tabular/#create_table) from the Tabular class. It will search through the model for all tables and partitions and pull the 'RefreshedTime' property from it. It will return results into a pandas dataframe, which will then be converted into an M expression used for a new table.
```python
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
df = pytabular.Table_Last_Refresh_Times(model, group_partition = False)
model.Create_Table(df, 'Refresh Times')
```

Backup & Revert a Table in Memory. USE WITH CAUTION, obviously not in PROD. I have been experimenting with this concept. Made for selfish reason. Will probably get removed and I'll keep in my own local version.

##### If BPA Violation, then revert deployment.
Uses a few things. First the [BPA Class](https://curts0.github.io/PyTabular/Best%20Practice%20Analyzer/#bpa), then the [TE2 Class](https://curts0.github.io/PyTabular/Tabular%20Editor%202/), and will finish with the [Analyze_BPA](https://curts0.github.io/PyTabular/Tabular/#analyze_bpa) method. Did not want to re-invent the wheel with the amazing work done with Tabular Editor and it's BPA capabilities.
```python
model.Backup_Table('TableName') #This will backup the table with surround items (columns,measures,relationships,roles,hierarchies,etc.) and will add a suffix of '_backup'
#Make any changes to your original table and then revert or delete backup as necessary
model.Revert_Table('TableName') #This will essentially replace your original with _backup
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
TE2 = pytabular.TE2() #Feel free to input your TE2 File path or this will download for you.
BPA = pytabular.BPA() #Fee free to input your own BPA file or this will download for you from: https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json
results = model.Analyze_BPA(TE2.EXE,BPA.Location)

if len(results) > 0:
#Revert deployment here!
```

Run BPA from TE2. Did not want to re-invent the wheel with the amazing work done with Tabular Editor and it's BPA capabilities. Two classes exist in the model in very basic form write now. But you can call pytabular.TE2() to download or specify and existing TE2 exe. The same goes for pytabular.BPA(). Input your own location for a BPA json file or will download one. Roadmap to make this more flexible.
##### Backup & Revert a Table.
USE WITH CAUTION, obviously not in PROD. I have been experimenting with this concept. Made for selfish reasons. Will probably get removed and I'll keep in my own local version. But fun to work with. Uses two methods. [Backup_Table](https://curts0.github.io/PyTabular/Tabular/#backup_table) and [Revert_Table](https://curts0.github.io/PyTabular/Tabular/#revert_table)

```python
TE2 = pytabular.TE2() #Feel free to input your TE2 File path or this will download for you.
BPA = pytabular.BPA() #Fee free to input your own BPA file or this will download for you from: https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json
model.Analyze_BPA(TE2.EXE,BPA.Location) #This will output a list of BPA violations...
import pytabular
model = pytabular.Tabular(CONNECTION_STR)
model.Backup_Table('TableName') #This will backup the table with surround items (columns,measures,relationships,roles,hierarchies,etc.) and will add a suffix of '_backup'
#-----------#
#Make any changes to your original table and then revert or delete backup as necessary
#-----------#
model.Revert_Table('TableName') #This will essentially replace your original with _backup
```
Binary file added dist/python_tabular-0.1.1-py3-none-any.whl
Binary file not shown.
Binary file added dist/python_tabular-0.1.1.tar.gz
Binary file not shown.
37 changes: 26 additions & 11 deletions docs/Tabular.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,24 @@ Runs on __init__ iterates through details, can be called after any model changes
* **bool** : True if successful


### .Disconnect
### .Is_Process
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L81)
```python
.Is_Process()
```

---
Run method to check if Processing is occurring. Will query DMV $SYSTEM.DISCOVER_JOBS to see if any processing is happening.


**Returns**

* **bool** : True if DMV shows Process, False if not.


### .Disconnect
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L89)
```python
.Disconnect()
```

Expand All @@ -66,7 +81,7 @@ Disconnects from Model


### .Refresh
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L89)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L97)
```python
.Refresh(
Object: Union[str, Table, Partition, Dict[str, Any]],
Expand Down Expand Up @@ -101,7 +116,7 @@ Dict[str, Any] == A way to specify a partition of group of partitions. For ex. {


### .Update
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L182)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L191)
```python
.Update(
UpdateOptions: UpdateOptions = UpdateOptions.ExpandFull
Expand All @@ -123,14 +138,14 @@ Dict[str, Any] == A way to specify a partition of group of partitions. For ex. {


### .SaveChanges
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L193)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L202)
```python
.SaveChanges()
```


### .Backup_Table
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L215)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L224)
```python
.Backup_Table(
table_str: str
Expand All @@ -154,7 +169,7 @@ Refresh is performed from source during backup.


### .Revert_Table
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L282)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L291)
```python
.Revert_Table(
table_str: str
Expand Down Expand Up @@ -182,7 +197,7 @@ Example scenario ->


### .Query
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L347)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L356)
```python
.Query(
Query_Str: str
Expand All @@ -206,7 +221,7 @@ It is also possible to query DMV. For example. Query("select * from $SYSTEM.DISC


### .Query_Every_Column
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L388)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L397)
```python
.Query_Every_Column(
query_function: str = 'COUNTROWS(VALUES(_))'
Expand All @@ -229,7 +244,7 @@ This will dynamically create a query to pull all columns from the model and run


### .Query_Every_Table
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L410)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L419)
```python
.Query_Every_Table(
query_function: str = 'COUNTROWS(_)'
Expand All @@ -252,7 +267,7 @@ It will replace the _ with the table to run.


### .Analyze_BPA
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L430)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L439)
```python
.Analyze_BPA(
Tabular_Editor_Exe: str, Best_Practice_Analyzer: str
Expand All @@ -277,7 +292,7 @@ Takes your Tabular Model and performs TE2s BPA. Runs through Command line.


### .Create_Table
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L454)
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/pytabular.py\#L463)
```python
.Create_Table(
df: pd.DataFrame, table_name: str
Expand Down
15 changes: 0 additions & 15 deletions docs/Traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,21 +128,6 @@ Call when you want to drop the Trace
* **None** : Returns None. Unless unsuccessful then it will return the error from Server.


### .Query_DMV_For_Event_Categories
[source](https://github.com/Curts0/PyTabular\blob\master\pytabular/tabular_tracing.py\#L111)
```python
.Query_DMV_For_Event_Categories()
```

---
Internal use. Called during the building process to locate allowed columns for event categories. This is done by executing a Tabular().Query() on the DISCOVER_EVENT_CATEGORIES table in the DMV. Then the function will parse the results, as it is xml inside of rows.


**Returns**

* **_type_** : _description_


----


Expand Down
Loading