Get Fields Example Code (tableau#51)

Russell Hay · web-flow · commit c8eb27e77fea · 2016-07-11T15:24:05.000-07:00
* Get Fields Example Code

* Adding field count and numbering

* updating comment to be accurate

* Adding GetFields to travis run

* Updating to use enumerate to keep track of count
diff --git a/.travis.yml b/.travis.yml
@@ -18,4 +18,5 @@ script:
   # Examples
   - (cd "Examples/Replicate Workbook" && python replicateWorkbook.py)
   - (cd "Examples/List TDS Info" && python listTDSInfo.py)
+  - (cd "Examples/GetFields" && python show_fields.py)
 
diff --git a/Examples/GetFields/World.tds b/Examples/GetFields/World.tds
@@ -0,0 +1 @@
+../List TDS Info/World.tds
diff --git a/Examples/GetFields/show_fields.py b/Examples/GetFields/show_fields.py
@@ -0,0 +1,29 @@
+############################################################
+# Step 1)  Use Datasource object from the Document API
+############################################################
+from tableaudocumentapi import Datasource
+
+############################################################
+# Step 2)  Open the .tds we want to inspect
+############################################################
+sourceTDS = Datasource.from_file('World.tds')
+
+############################################################
+# Step 3)  Print out all of the fields and what type they are
+############################################################
+print('----------------------------------------------------------')
+print('--- {} total fields in this datasource'.format(len(sourceTDS.fields)))
+print('----------------------------------------------------------')
+for count, field in enumerate(sourceTDS.fields.values()):
+    print('{:>4}: {} is a {}'.format(count+1, field.name, field.datatype))
+    blank_line = False
+    if field.calculation:
+        print('      the formula is {}'.format(field.calculation))
+        blank_line = True
+    if field.aggregation:
+        print('      the default aggregation is {}'.format(field.aggregation))
+        blank_line = True
+
+    if blank_line:
+        print('')
+print('----------------------------------------------------------')
